<!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: message.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">message.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="message_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> <span class="preprocessor">#if !defined(_usb_h_) || defined(__MESSAGE_H__)</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#error "Never include message.h directly; include Usb.h instead"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define __MESSAGE_H__</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="message_8h.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a9453192fd38607a494776eb3fb483630">E_Notify</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * msg, <span class="keywordtype">int</span> lvl);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a9453192fd38607a494776eb3fb483630">E_Notify</a>(uint8_t b, <span class="keywordtype">int</span> lvl);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a519befe6a36026b8ea81aec9d6a3e532">E_NotifyStr</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * msg, <span class="keywordtype">int</span> lvl);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#ab0e5c13883e60a998bb19346a9474066">E_Notifyc</a>(<span class="keywordtype">char</span> c, <span class="keywordtype">int</span> lvl);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifdef DEBUG_USB_HOST</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define Notify E_Notify</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define NotifyStr E_NotifyStr</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define Notifyc E_Notifyc</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#ae65e02f44cfdc490efd1b33f9882fbbd">NotifyFailGetDevDescr</a>(uint8_t reason);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a69619d86b1636f141c830ca82c7f45e7">NotifyFailSetDevTblEntry</a>(uint8_t reason);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a38aabfb47a8bf743b0532e356c39faaf">NotifyFailGetConfDescr</a>(uint8_t reason);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a03e4088aafca36fd7a4be69e3a22b601">NotifyFailSetConfDescr</a>(uint8_t reason);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#ae65e02f44cfdc490efd1b33f9882fbbd">NotifyFailGetDevDescr</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a69619d86b1636f141c830ca82c7f45e7">NotifyFailSetDevTblEntry</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a38aabfb47a8bf743b0532e356c39faaf">NotifyFailGetConfDescr</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a03e4088aafca36fd7a4be69e3a22b601">NotifyFailSetConfDescr</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a0ce3a725ee65614d7f95cda10e4d2e91">NotifyFailUnknownDevice</a>(uint16_t VID, uint16_t PID);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a22695bdc18ebde4a87dbe8633cb39593">NotifyFail</a>(uint8_t rcode);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338"> 51</a></span> <span class="preprocessor">#define Notify(...) ((void)0)</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="message_8h.html#aa41f0e761e43cb026f1c7f04f75fa24e"> 52</a></span> <span class="preprocessor">#define NotifyStr(...) ((void)0)</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="message_8h.html#ab5d8177365493b21dbc092f6557bd508"> 53</a></span> <span class="preprocessor">#define Notifyc(...) ((void)0)</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define NotifyFailGetDevDescr(...) ((void)0)</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define NotifyFailSetDevTblEntry(...) ((void)0)</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define NotifyFailGetConfDescr(...) ((void)0)</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="message_8h.html#ae65e02f44cfdc490efd1b33f9882fbbd"> 57</a></span> <span class="preprocessor">#define NotifyFailGetDevDescr(...) ((void)0)</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="message_8h.html#a69619d86b1636f141c830ca82c7f45e7"> 58</a></span> <span class="preprocessor">#define NotifyFailSetDevTblEntry(...) ((void)0)</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="message_8h.html#a38aabfb47a8bf743b0532e356c39faaf"> 59</a></span> <span class="preprocessor">#define NotifyFailGetConfDescr(...) ((void)0)</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="message_8h.html#a03e4088aafca36fd7a4be69e3a22b601"> 60</a></span> <span class="preprocessor">#define NotifyFailSetConfDescr(...) ((void)0)</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="message_8h.html#a0ce3a725ee65614d7f95cda10e4d2e91"> 61</a></span> <span class="preprocessor">#define NotifyFailUnknownDevice(...) ((void)0)</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="message_8h.html#a22695bdc18ebde4a87dbe8633cb39593"> 62</a></span> <span class="preprocessor">#define NotifyFail(...) ((void)0)</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">template</span> <<span class="keyword">class</span> ERROR_TYPE></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="message_8h.html#a59dd0ba2acd4a416786f45d1e0b0916a"> 66</a></span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a59dd0ba2acd4a416786f45d1e0b0916a">ErrorMessage</a>(uint8_t level, <span class="keywordtype">char</span> <span class="keyword">const</span> * msg, ERROR_TYPE rcode = 0) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#ifdef DEBUG_USB_HOST</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(msg, level);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(<a class="code" href="version__helper_8h.html#a73809107539df84eaf01f6a4dea4fbff">PSTR</a>(<span class="stringliteral">": "</span>), level);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  D_PrintHex<ERROR_TYPE > (rcode, level);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(<a class="code" href="version__helper_8h.html#a73809107539df84eaf01f6a4dea4fbff">PSTR</a>(<span class="stringliteral">"\r\n"</span>), level);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">template</span> <<span class="keyword">class</span> ERROR_TYPE></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="message_8h.html#a52358bfe833f47f63e7de398847aa2e7"> 76</a></span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a59dd0ba2acd4a416786f45d1e0b0916a">ErrorMessage</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * msg __attribute__((unused)), ERROR_TYPE rcode __attribute__((unused)) = 0) {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#ifdef DEBUG_USB_HOST</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(msg, 0x80);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(<a class="code" href="version__helper_8h.html#a73809107539df84eaf01f6a4dea4fbff">PSTR</a>(<span class="stringliteral">": "</span>), 0x80);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  D_PrintHex<ERROR_TYPE > (rcode, 0x80);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a>(<a class="code" href="version__helper_8h.html#a73809107539df84eaf01f6a4dea4fbff">PSTR</a>(<span class="stringliteral">"\r\n"</span>), 0x80);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // __MESSAGE_H__</span></div><div class="ttc" id="message_8h_html_a9453192fd38607a494776eb3fb483630"><div class="ttname"><a href="message_8h.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#l00041">message.cpp:41</a></div></div>
<div class="ttc" id="message_8h_html_a22695bdc18ebde4a87dbe8633cb39593"><div class="ttname"><a href="message_8h.html#a22695bdc18ebde4a87dbe8633cb39593">NotifyFail</a></div><div class="ttdeci">#define NotifyFail(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00062">message.h:62</a></div></div>
<div class="ttc" id="message_8h_html_ae65e02f44cfdc490efd1b33f9882fbbd"><div class="ttname"><a href="message_8h.html#ae65e02f44cfdc490efd1b33f9882fbbd">NotifyFailGetDevDescr</a></div><div class="ttdeci">#define NotifyFailGetDevDescr(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00057">message.h:57</a></div></div>
<div class="ttc" id="message_8h_html_a519befe6a36026b8ea81aec9d6a3e532"><div class="ttname"><a href="message_8h.html#a519befe6a36026b8ea81aec9d6a3e532">E_NotifyStr</a></div><div class="ttdeci">void E_NotifyStr(char const *msg, int lvl)</div><div class="ttdef"><b>Definition:</b> <a href="message_8cpp_source.html#l00049">message.cpp:49</a></div></div>
<div class="ttc" id="message_8h_html_a27117e124c5d66d5512fe8d494fe6338"><div class="ttname"><a href="message_8h.html#a27117e124c5d66d5512fe8d494fe6338">Notify</a></div><div class="ttdeci">#define Notify(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00051">message.h:51</a></div></div>
<div class="ttc" id="message_8h_html_a38aabfb47a8bf743b0532e356c39faaf"><div class="ttname"><a href="message_8h.html#a38aabfb47a8bf743b0532e356c39faaf">NotifyFailGetConfDescr</a></div><div class="ttdeci">#define NotifyFailGetConfDescr(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00059">message.h:59</a></div></div>
<div class="ttc" id="message_8h_html_a0ce3a725ee65614d7f95cda10e4d2e91"><div class="ttname"><a href="message_8h.html#a0ce3a725ee65614d7f95cda10e4d2e91">NotifyFailUnknownDevice</a></div><div class="ttdeci">#define NotifyFailUnknownDevice(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00061">message.h:61</a></div></div>
<div class="ttc" id="message_8h_html_ab0e5c13883e60a998bb19346a9474066"><div class="ttname"><a href="message_8h.html#ab0e5c13883e60a998bb19346a9474066">E_Notifyc</a></div><div class="ttdeci">void E_Notifyc(char c, int lvl)</div><div class="ttdef"><b>Definition:</b> <a href="message_8cpp_source.html#l00031">message.cpp:31</a></div></div>
<div class="ttc" id="version__helper_8h_html_a73809107539df84eaf01f6a4dea4fbff"><div class="ttname"><a href="version__helper_8h.html#a73809107539df84eaf01f6a4dea4fbff">PSTR</a></div><div class="ttdeci">#define PSTR(str)</div><div class="ttdef"><b>Definition:</b> <a href="version__helper_8h_source.html#l00054">version_helper.h:54</a></div></div>
<div class="ttc" id="message_8h_html_a25b114fa75a1d5c09bde2dadc5a27f78"><div class="ttname"><a href="message_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="message_8h_html_a59dd0ba2acd4a416786f45d1e0b0916a"><div class="ttname"><a href="message_8h.html#a59dd0ba2acd4a416786f45d1e0b0916a">ErrorMessage</a></div><div class="ttdeci">void ErrorMessage(uint8_t level, char const *msg, ERROR_TYPE rcode=0)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00066">message.h:66</a></div></div>
<div class="ttc" id="message_8h_html_a03e4088aafca36fd7a4be69e3a22b601"><div class="ttname"><a href="message_8h.html#a03e4088aafca36fd7a4be69e3a22b601">NotifyFailSetConfDescr</a></div><div class="ttdeci">#define NotifyFailSetConfDescr(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00060">message.h:60</a></div></div>
<div class="ttc" id="message_8h_html_a69619d86b1636f141c830ca82c7f45e7"><div class="ttname"><a href="message_8h.html#a69619d86b1636f141c830ca82c7f45e7">NotifyFailSetDevTblEntry</a></div><div class="ttdeci">#define NotifyFailSetDevTblEntry(...)</div><div class="ttdef"><b>Definition:</b> <a href="message_8h_source.html#l00058">message.h:58</a></div></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>