mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
155 lines
15 KiB
HTML
155 lines
15 KiB
HTML
<!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.3.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/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"/>
|
|
</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
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.3.1 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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>
|
|
</div>
|
|
</div><!-- top -->
|
|
<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 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> <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> <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> <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> <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> <span class="comment">the GPL2 ("Copyleft").</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Contact information</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">-------------------</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">Circuits At Home, LTD</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">Web : http://www.circuitsathome.com</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">e-mail : support@circuitsathome.com</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="preprocessor">#if !defined(__MESSAGE_H__)</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __MESSAGE_H__</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <inttypes.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <avr/pgmspace.h></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="message_8cpp.html#a25b114fa75a1d5c09bde2dadc5a27f78">UsbDEBUGlvl</a>;</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">#include "<a class="code" href="printhex_8h.html">printhex.h</a>"</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">void</span> <a class="code" href="message_8cpp.html#a1e8693828152de8408add858dc461dea">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="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> <a class="code" href="message_8cpp.html#a389f3cf4766145374f70464477c3156a">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="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef DEBUG</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="keywordtype">void</span> <a class="code" href="message_8h.html#a9a7f2f4c3d000d5017ee1d0bacd57ff1">NotifyFailGetDevDescr</a>(<span class="keywordtype">void</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#a221739ed933e6f3d0c2533d12e3c5e6e">NotifyFailSetDevTblEntry</a>(<span class="keywordtype">void</span>);</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#a66511c691935586edd527d0333662650">NotifyFailGetConfDescr</a>(<span class="keywordtype">void</span>);</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#a74853f99e2c72f25393f4e4d97518b0c">NotifyFailSetConfDescr</a>(<span class="keywordtype">void</span>);</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#aae736f590b1ff3782749a4587e5c3fce">NotifyFailUnknownDevice</a>(uint16_t VID, uint16_t PID);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a0ff5fd979410766516f888b2c04e6bf2">NotifyFail</a>(uint8_t rcode);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="message_8h.html#a9a7f2f4c3d000d5017ee1d0bacd57ff1"> 37</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFailGetDevDescr()</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="message_8h.html#a221739ed933e6f3d0c2533d12e3c5e6e"> 38</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFailSetDevTblEntry()</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="message_8h.html#a66511c691935586edd527d0333662650"> 39</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFailGetConfDescr()</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="message_8h.html#a74853f99e2c72f25393f4e4d97518b0c"> 40</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFailSetConfDescr()</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="message_8h.html#aae736f590b1ff3782749a4587e5c3fce"> 41</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFailUnknownDevice(VID, PID)</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="message_8h.html#a0ff5fd979410766516f888b2c04e6bf2"> 42</a></span> <span class="preprocessor"></span><span class="preprocessor">#define NotifyFail(rcode)</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span> <<span class="keyword">class</span> ERROR_TYPE></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="message_8h.html#a52358bfe833f47f63e7de398847aa2e7"> 46</a></span> <span class="keywordtype">void</span> <a class="code" href="message_8h.html#a52358bfe833f47f63e7de398847aa2e7">ErrorMessage</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * msg, ERROR_TYPE rcode = 0) {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="message_8cpp.html#a1e8693828152de8408add858dc461dea">Notify</a>(msg, 0x80);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="message_8cpp.html#a1e8693828152de8408add858dc461dea">Notify</a>(PSTR(<span class="stringliteral">": "</span>), 0x80);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  PrintHex<ERROR_TYPE > (rcode, 0x80);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="message_8cpp.html#a1e8693828152de8408add858dc461dea">Notify</a>(PSTR(<span class="stringliteral">"\r\n"</span>), 0x80);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#include "<a class="code" href="hexdump_8h.html">hexdump.h</a>"</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif // __MESSAGE_H__</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.3.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|