Mirrors/gbdk-2020
2
0
Fork 0
mirror of https://github.com/gbdk-2020/gbdk-2020.git synced 2026-03-03 05:54:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
develop
gbdk-2020/docs/api/laptop__io_8h_source.html
bbbbbr a5bff5a9e8 Docs: 4.5.0: Regenerate content
2025-12-27 17:53:11 -08:00

271 lines
35 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.14-->
<!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="cache-control" content="max-age=86400"/>
<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.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GBDK 2020 Docs: gbdk-lib/include/duck/laptop_io.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<!-- BEGIN: doxygen-awesome-css -->
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<!-- END: doxygen-awesome-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">GBDK 2020 Docs
&#160;<span id="projectnumber">4.5.0</span>
</div>
<div id="projectbrief">API Documentation for GBDK 2020</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('laptop__io_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">laptop_io.h</div></div>
</div><!--header-->
<div class="contents">
<a href="laptop__io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;<a class="code" href="platform_8h.html">gbdk/platform.h</a>&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;<a class="code" href="stdint_8h.html">stdint.h</a>&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;<a class="code" href="stdbool_8h.html">stdbool.h</a>&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#ifndef _MEGADUCK_LAPTOP_IO_H</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#_MEGADUCK_LAPTOP_IO_H"> 27</a></span><span class="preprocessor">#define _MEGADUCK_LAPTOP_IO_H</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// Commands sent via serial IO to the Duck laptop peripheral hardware</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_INIT_START"> 31</a></span><span class="preprocessor">#define DUCK_IO_CMD_INIT_START 0x00u </span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_GET_KEYS"> 32</a></span><span class="preprocessor">#define DUCK_IO_CMD_GET_KEYS 0x00u </span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_DONE_OR_OK"> 33</a></span><span class="preprocessor">#define DUCK_IO_CMD_DONE_OR_OK 0x01u</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// #define DUCK_IO_CMD_DONE_OR_OK_AND_SOMETHING 0x81u</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_ABORT_OR_FAIL"> 35</a></span><span class="preprocessor">#define DUCK_IO_CMD_ABORT_OR_FAIL 0x04u</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_PLAY_SPEECH"> 36</a></span><span class="preprocessor">#define DUCK_IO_CMD_PLAY_SPEECH 0x05u</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_RUN_CART_IN_SLOT"> 37</a></span><span class="preprocessor">#define DUCK_IO_CMD_RUN_CART_IN_SLOT 0x08u</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_PRINT_INIT_EXT_IO"> 38</a></span><span class="preprocessor">#define DUCK_IO_CMD_PRINT_INIT_EXT_IO 0x09u </span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_SET_RTC"> 39</a></span><span class="preprocessor">#define DUCK_IO_CMD_SET_RTC 0x0Bu </span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_GET_RTC"> 40</a></span><span class="preprocessor">#define DUCK_IO_CMD_GET_RTC 0x0Cu </span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_CMD_PRINT_SEND_BYTES"> 41</a></span><span class="preprocessor">#define DUCK_IO_CMD_PRINT_SEND_BYTES 0x11u </span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">// #define FF60_REG_BEFORE_XFER 0x00u</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_BOOT_UNSET"> 45</a></span><span class="preprocessor">#define DUCK_IO_REPLY_BOOT_UNSET 0x00u</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_BOOT_FAIL"> 46</a></span><span class="preprocessor">#define DUCK_IO_REPLY_BOOT_FAIL 0x01u</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_BUFFER_XFER_OK"> 47</a></span><span class="preprocessor">#define DUCK_IO_REPLY_BUFFER_XFER_OK 0x01u</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_SEND_BUFFER_OK"> 48</a></span><span class="preprocessor">#define DUCK_IO_REPLY_SEND_BUFFER_OK 0x03u</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">// #define DUCK_IO_REPLY_READ_FAIL_MAYBE 0x00u</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_BOOT_OK"> 50</a></span><span class="preprocessor">#define DUCK_IO_REPLY_BOOT_OK 0x01u</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_KBD_GET"> 52</a></span><span class="preprocessor">#define DUCK_IO_LEN_KBD_GET 2u </span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_RTC_GET"> 53</a></span><span class="preprocessor">#define DUCK_IO_LEN_RTC_GET 8u </span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_RTC_SET"> 54</a></span><span class="preprocessor">#define DUCK_IO_LEN_RTC_SET 8u </span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_PLAY_SPEECH"> 55</a></span><span class="preprocessor">#define DUCK_IO_LEN_PLAY_SPEECH 1u </span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_REPLY_NO_CART_IN_SLOT"> 57</a></span><span class="preprocessor">#define DUCK_IO_REPLY_NO_CART_IN_SLOT 06u</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment">// #define MEGADUCK_KBD_BYTE_1_EXPECT 0x0Eu</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment">// #define MEGADUCK_SIO_BOOT_OK 0x01u</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_RX_MAX"> 62</a></span><span class="preprocessor">#define DUCK_IO_LEN_RX_MAX 14u </span><span class="comment">// 13 data bytes + 1 checksum byte max reply length?</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_LEN_TX_MAX"> 63</a></span><span class="preprocessor">#define DUCK_IO_LEN_TX_MAX 14u </span><span class="comment">// 13 data bytes + 1 checksum byte max reply length?</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_TIMEOUT_2_MSEC"> 65</a></span><span class="preprocessor">#define DUCK_IO_TIMEOUT_2_MSEC 2u </span><span class="comment">// Used for hardware init counter sequence</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_TIMEOUT_100_MSEC"> 66</a></span><span class="preprocessor">#define DUCK_IO_TIMEOUT_100_MSEC 100u</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_TIMEOUT_200_MSEC"> 67</a></span><span class="preprocessor">#define DUCK_IO_TIMEOUT_200_MSEC 200u</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">// Pre-recorded Speech Samples for playback</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_SPEECH_CMD_MIN"> 71</a></span><span class="preprocessor">#define DUCK_IO_SPEECH_CMD_MIN 1</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_SPEECH_CMD_MAX"> 72</a></span><span class="preprocessor">#define DUCK_IO_SPEECH_CMD_MAX 6</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">// RTC packet byte ordering (all in BCD format)</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_YEAR"> 76</a></span><span class="preprocessor">#define DUCK_IO_RTC_YEAR 0u</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_MON"> 77</a></span><span class="preprocessor">#define DUCK_IO_RTC_MON 1u</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_DAY"> 78</a></span><span class="preprocessor">#define DUCK_IO_RTC_DAY 2u</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_WEEKDAY"> 79</a></span><span class="preprocessor">#define DUCK_IO_RTC_WEEKDAY 3u</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_AMPM"> 80</a></span><span class="preprocessor">#define DUCK_IO_RTC_AMPM 4u</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_HOUR"> 81</a></span><span class="preprocessor">#define DUCK_IO_RTC_HOUR 5u</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_MIN"> 82</a></span><span class="preprocessor">#define DUCK_IO_RTC_MIN 6u</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_RTC_SEC"> 83</a></span><span class="preprocessor">#define DUCK_IO_RTC_SEC 7u</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment">// Keyboard packet byte ordering (all in BCD format)</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_KBD_FLAGS"> 87</a></span><span class="preprocessor">#define DUCK_IO_KBD_FLAGS 0u</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_KBD_KEYCODE"> 88</a></span><span class="preprocessor">#define DUCK_IO_KBD_KEYCODE 1u</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">// Printer init reply related</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment">// Init Reply Bits:1..0</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_PRINTER_FAIL"> 93</a></span><span class="preprocessor">#define DUCK_IO_PRINTER_FAIL 0x00u</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_PRINTER_TYPE_2_PASS"> 94</a></span><span class="preprocessor">#define DUCK_IO_PRINTER_TYPE_2_PASS 0x01u </span><span class="comment">// Bit.1 = 0 // 13 x 12 byte packets + 1 x 5 or 6 byte packet (with CR and/or LF)</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_PRINTER_TYPE_1_PASS"> 95</a></span><span class="preprocessor">#define DUCK_IO_PRINTER_TYPE_1_PASS 0x02u </span><span class="comment">// Bit.1 = 1 // 3 x 12 byte packets + 118 non-packet bytes</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#DUCK_IO_PRINTER_MAYBE_BUSY"> 96</a></span><span class="preprocessor">#define DUCK_IO_PRINTER_MAYBE_BUSY 0x03u </span><span class="comment">// Maybe indicating that Printer Type 1 is busy?</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="keyword">extern</span> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_rx_byte_done">duck_io_rx_byte_done</a>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="keyword">extern</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_rx_byte">duck_io_rx_byte</a>;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment">// TODO: change these to user supplied buffers?</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="keyword">extern</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_rx_buf">duck_io_rx_buf</a>[<a class="code hl_define" href="laptop__io_8h.html#DUCK_IO_LEN_RX_MAX">DUCK_IO_LEN_RX_MAX</a>];</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="keyword">extern</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_rx_buf_len">duck_io_rx_buf_len</a>;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="keyword">extern</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_tx_buf">duck_io_tx_buf</a>[<a class="code hl_define" href="laptop__io_8h.html#DUCK_IO_LEN_TX_MAX">DUCK_IO_LEN_TX_MAX</a>];</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="keyword">extern</span> <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_variable" href="laptop__io_8h.html#duck_io_tx_buf_len">duck_io_tx_buf_len</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment">// ===== Low level helper IO functions =====</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">// TODO: No longer in use(?)</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">//</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">// Waits for a serial transfer to complete with a timeout</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment">//</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment">// @param timeout_len_ms Unit size is in msec (100 is about ~ 103 msec or 6.14 frames)</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment">//</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment">// Serial ISR populates status var if anything was received</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment">//</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment">// void duck_io_wait_done_with_timeout(uint8_t timeout_len_ms);</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_send_byte"> 130</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_send_byte">duck_io_send_byte</a>(<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> tx_byte);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_read_byte_no_timeout"> 139</a></span><a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_function" href="laptop__io_8h.html#duck_io_read_byte_no_timeout">duck_io_read_byte_no_timeout</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_enable_read_byte"> 150</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_enable_read_byte">duck_io_enable_read_byte</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_laptop_init"> 163</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_laptop_init">duck_io_laptop_init</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_printer_last_status"> 179</a></span><a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_function" href="laptop__io_8h.html#duck_io_printer_last_status">duck_io_printer_last_status</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_printer_query"> 195</a></span><a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> <a class="code hl_function" href="laptop__io_8h.html#duck_io_printer_query">duck_io_printer_query</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> </div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span><span class="comment">// ===== Higher level IO functions =====</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_read_byte_with_msecs_tim"> 209</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_read_byte_with_msecs_tim">duck_io_read_byte_with_msecs_timeout</a>(<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> timeout_len_ms);</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_send_byte_and_check_ack_"> 222</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_send_byte_and_check_ack_">duck_io_send_byte_and_check_ack_msecs_timeout</a>(<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> tx_byte, <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> timeout_len_ms, <a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> expected_reply);</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_send_cmd_and_buffer"> 237</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_send_cmd_and_buffer">duck_io_send_cmd_and_buffer</a>(<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> io_cmd);</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> </div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"><a class="line" href="laptop__io_8h.html#duck_io_send_cmd_and_receive_buf"> 252</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="laptop__io_8h.html#duck_io_send_cmd_and_receive_buf">duck_io_send_cmd_and_receive_buffer</a>(<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> io_cmd);</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span><span class="preprocessor">#endif </span><span class="comment">// _MEGADUCK_LAPTOP_IO_H</span></div>
<div class="ttc" id="alaptop__io_8h_html_DUCK_IO_LEN_RX_MAX"><div class="ttname"><a href="laptop__io_8h.html#DUCK_IO_LEN_RX_MAX">DUCK_IO_LEN_RX_MAX</a></div><div class="ttdeci">#define DUCK_IO_LEN_RX_MAX</div><div class="ttdef"><b>Definition:</b> laptop_io.h:62</div></div>
<div class="ttc" id="alaptop__io_8h_html_DUCK_IO_LEN_TX_MAX"><div class="ttname"><a href="laptop__io_8h.html#DUCK_IO_LEN_TX_MAX">DUCK_IO_LEN_TX_MAX</a></div><div class="ttdeci">#define DUCK_IO_LEN_TX_MAX</div><div class="ttdef"><b>Definition:</b> laptop_io.h:63</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_enable_read_byte"><div class="ttname"><a href="laptop__io_8h.html#duck_io_enable_read_byte">duck_io_enable_read_byte</a></div><div class="ttdeci">void duck_io_enable_read_byte(void)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_laptop_init"><div class="ttname"><a href="laptop__io_8h.html#duck_io_laptop_init">duck_io_laptop_init</a></div><div class="ttdeci">bool duck_io_laptop_init(void)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_printer_last_status"><div class="ttname"><a href="laptop__io_8h.html#duck_io_printer_last_status">duck_io_printer_last_status</a></div><div class="ttdeci">uint8_t duck_io_printer_last_status(void)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_printer_query"><div class="ttname"><a href="laptop__io_8h.html#duck_io_printer_query">duck_io_printer_query</a></div><div class="ttdeci">uint8_t duck_io_printer_query(void)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_read_byte_no_timeout"><div class="ttname"><a href="laptop__io_8h.html#duck_io_read_byte_no_timeout">duck_io_read_byte_no_timeout</a></div><div class="ttdeci">uint8_t duck_io_read_byte_no_timeout(void)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_read_byte_with_msecs_tim"><div class="ttname"><a href="laptop__io_8h.html#duck_io_read_byte_with_msecs_tim">duck_io_read_byte_with_msecs_timeout</a></div><div class="ttdeci">bool duck_io_read_byte_with_msecs_timeout(uint8_t timeout_len_ms)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_rx_buf"><div class="ttname"><a href="laptop__io_8h.html#duck_io_rx_buf">duck_io_rx_buf</a></div><div class="ttdeci">uint8_t duck_io_rx_buf[DUCK_IO_LEN_RX_MAX]</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_rx_buf_len"><div class="ttname"><a href="laptop__io_8h.html#duck_io_rx_buf_len">duck_io_rx_buf_len</a></div><div class="ttdeci">uint8_t duck_io_rx_buf_len</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_rx_byte"><div class="ttname"><a href="laptop__io_8h.html#duck_io_rx_byte">duck_io_rx_byte</a></div><div class="ttdeci">volatile uint8_t duck_io_rx_byte</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_rx_byte_done"><div class="ttname"><a href="laptop__io_8h.html#duck_io_rx_byte_done">duck_io_rx_byte_done</a></div><div class="ttdeci">volatile bool duck_io_rx_byte_done</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_send_byte"><div class="ttname"><a href="laptop__io_8h.html#duck_io_send_byte">duck_io_send_byte</a></div><div class="ttdeci">void duck_io_send_byte(uint8_t tx_byte)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_send_byte_and_check_ack_"><div class="ttname"><a href="laptop__io_8h.html#duck_io_send_byte_and_check_ack_">duck_io_send_byte_and_check_ack_msecs_timeout</a></div><div class="ttdeci">bool duck_io_send_byte_and_check_ack_msecs_timeout(uint8_t tx_byte, uint8_t timeout_len_ms, uint8_t expected_reply)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_send_cmd_and_buffer"><div class="ttname"><a href="laptop__io_8h.html#duck_io_send_cmd_and_buffer">duck_io_send_cmd_and_buffer</a></div><div class="ttdeci">bool duck_io_send_cmd_and_buffer(uint8_t io_cmd)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_send_cmd_and_receive_buf"><div class="ttname"><a href="laptop__io_8h.html#duck_io_send_cmd_and_receive_buf">duck_io_send_cmd_and_receive_buffer</a></div><div class="ttdeci">bool duck_io_send_cmd_and_receive_buffer(uint8_t io_cmd)</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_tx_buf"><div class="ttname"><a href="laptop__io_8h.html#duck_io_tx_buf">duck_io_tx_buf</a></div><div class="ttdeci">uint8_t duck_io_tx_buf[DUCK_IO_LEN_TX_MAX]</div></div>
<div class="ttc" id="alaptop__io_8h_html_duck_io_tx_buf_len"><div class="ttname"><a href="laptop__io_8h.html#duck_io_tx_buf_len">duck_io_tx_buf_len</a></div><div class="ttdeci">uint8_t duck_io_tx_buf_len</div></div>
<div class="ttc" id="aplatform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div>
<div class="ttc" id="astdbool_8h_html"><div class="ttname"><a href="stdbool_8h.html">stdbool.h</a></div></div>
<div class="ttc" id="astdint_8h_html"><div class="ttname"><a href="stdint_8h.html">stdint.h</a></div></div>
<div class="ttc" id="astdint_8h_html_uint8_t"><div class="ttname"><a href="stdint_8h.html#uint8_t">uint8_t</a></div><div class="ttdeci">unsigned char uint8_t</div><div class="ttdef"><b>Definition:</b> stdint.h:51</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="dir_0a499b1b991479a5f341a18a1dd374d9.html">duck</a></li><li class="navelem"><a class="el" href="laptop__io_8h.html">laptop_io.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink