Files
gbdk-2020/docs/api/far__ptr_8h_source.html
2025-12-27 17:53:11 -08:00

173 lines
16 KiB
HTML

<!-- 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/gbdk/far_ptr.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('far__ptr_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">far_ptr.h</div></div>
</div><!--header-->
<div class="contents">
<a href="far__ptr_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> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#ifndef __FAR_PTR_H_INCLUDE</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#define __FAR_PTR_H_INCLUDE</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;types.h&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="stdint_8h.html">stdint.h</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#TO_FAR_PTR"> 25</a></span><span class="preprocessor">#define TO_FAR_PTR(ofs, seg) (((FAR_PTR)seg &lt;&lt; 16) | (FAR_PTR)ofs)</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#FAR_SEG"> 32</a></span><span class="preprocessor">#define FAR_SEG(ptr) (((union __far_ptr *)&amp;ptr)-&gt;segofs.seg)</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#FAR_OFS"> 39</a></span><span class="preprocessor">#define FAR_OFS(ptr) (((union __far_ptr *)&amp;ptr)-&gt;segofs.ofs)</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#FAR_FUNC"> 41</a></span><span class="preprocessor">#define FAR_FUNC(ptr, typ) ((typ)(((union __far_ptr *)&amp;ptr)-&gt;segfn.fn))</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#FAR_CALL"> 65</a></span><span class="preprocessor">#define FAR_CALL(ptr, typ, ...) (__call_banked_ptr=ptr,((typ)(&amp;__call__banked))(__VA_ARGS__))</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#FAR_PTR"> 69</a></span><span class="keyword">typedef</span> <a class="code hl_typedef" href="stdint_8h.html#uint32_t">uint32_t</a> <a class="code hl_typedef" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="union____far__ptr.html"> 73</a></span><span class="keyword">union </span><a class="code hl_union" href="union____far__ptr.html">__far_ptr</a> {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="union____far__ptr.html#ptr"> 74</a></span> <a class="code hl_typedef" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a> <a class="code hl_variable" href="union____far__ptr.html#ptr">ptr</a>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="union____far__ptr.html#ofs"> 76</a></span> <span class="keywordtype">void</span> * <a class="code hl_variable" href="union____far__ptr.html#ofs">ofs</a>;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="union____far__ptr.html#seg"> 77</a></span> <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> <a class="code hl_variable" href="union____far__ptr.html#seg">seg</a>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="union____far__ptr.html#segofs"> 78</a></span> } <a class="code hl_variable" href="union____far__ptr.html#segofs">segofs</a>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="union____far__ptr.html#fn"> 80</a></span> void (*<a class="code hl_variable" href="union____far__ptr.html#fn">fn</a>)(void);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> <a class="code hl_variable" href="union____far__ptr.html#seg">seg</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="union____far__ptr.html#segfn"> 82</a></span> } <a class="code hl_variable" href="union____far__ptr.html#segfn">segfn</a>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</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><span class="keyword">extern</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a> <a class="code hl_variable" href="far__ptr_8h.html#__call_banked_ptr">__call_banked_ptr</a>;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">extern</span> <span class="keyword">volatile</span> <span class="keywordtype">void</span> * <a class="code hl_variable" href="far__ptr_8h.html#__call_banked_addr">__call_banked_addr</a>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</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="far__ptr_8h.html#__call_banked_bank">__call_banked_bank</a>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#__call__banked"> 89</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="far__ptr_8h.html#__call__banked">__call__banked</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="far__ptr_8h.html#to_far_ptr"> 97</a></span><a class="code hl_typedef" href="stdint_8h.html#uint32_t">uint32_t</a> <a class="code hl_function" href="far__ptr_8h.html#to_far_ptr">to_far_ptr</a>(<span class="keywordtype">void</span>* ofs, <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> seg);</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="preprocessor">#endif</span></div>
<div class="ttc" id="afar__ptr_8h_html_FAR_PTR"><div class="ttname"><a href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a></div><div class="ttdeci">uint32_t FAR_PTR</div><div class="ttdef"><b>Definition:</b> far_ptr.h:69</div></div>
<div class="ttc" id="afar__ptr_8h_html___call__banked"><div class="ttname"><a href="far__ptr_8h.html#__call__banked">__call__banked</a></div><div class="ttdeci">void __call__banked(void)</div></div>
<div class="ttc" id="afar__ptr_8h_html___call_banked_addr"><div class="ttname"><a href="far__ptr_8h.html#__call_banked_addr">__call_banked_addr</a></div><div class="ttdeci">volatile void * __call_banked_addr</div></div>
<div class="ttc" id="afar__ptr_8h_html___call_banked_bank"><div class="ttname"><a href="far__ptr_8h.html#__call_banked_bank">__call_banked_bank</a></div><div class="ttdeci">volatile uint8_t __call_banked_bank</div></div>
<div class="ttc" id="afar__ptr_8h_html___call_banked_ptr"><div class="ttname"><a href="far__ptr_8h.html#__call_banked_ptr">__call_banked_ptr</a></div><div class="ttdeci">volatile FAR_PTR __call_banked_ptr</div></div>
<div class="ttc" id="afar__ptr_8h_html_to_far_ptr"><div class="ttname"><a href="far__ptr_8h.html#to_far_ptr">to_far_ptr</a></div><div class="ttdeci">uint32_t to_far_ptr(void *ofs, uint16_t seg)</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_uint16_t"><div class="ttname"><a href="stdint_8h.html#uint16_t">uint16_t</a></div><div class="ttdeci">unsigned short int uint16_t</div><div class="ttdef"><b>Definition:</b> stdint.h:52</div></div>
<div class="ttc" id="astdint_8h_html_uint32_t"><div class="ttname"><a href="stdint_8h.html#uint32_t">uint32_t</a></div><div class="ttdeci">unsigned long int uint32_t</div><div class="ttdef"><b>Definition:</b> stdint.h:53</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 class="ttc" id="aunion____far__ptr_html"><div class="ttname"><a href="union____far__ptr.html">__far_ptr</a></div><div class="ttdef"><b>Definition:</b> far_ptr.h:73</div></div>
<div class="ttc" id="aunion____far__ptr_html_fn"><div class="ttname"><a href="union____far__ptr.html#fn">__far_ptr::fn</a></div><div class="ttdeci">void(* fn)(void)</div><div class="ttdef"><b>Definition:</b> far_ptr.h:80</div></div>
<div class="ttc" id="aunion____far__ptr_html_ofs"><div class="ttname"><a href="union____far__ptr.html#ofs">__far_ptr::ofs</a></div><div class="ttdeci">void * ofs</div><div class="ttdef"><b>Definition:</b> far_ptr.h:76</div></div>
<div class="ttc" id="aunion____far__ptr_html_ptr"><div class="ttname"><a href="union____far__ptr.html#ptr">__far_ptr::ptr</a></div><div class="ttdeci">FAR_PTR ptr</div><div class="ttdef"><b>Definition:</b> far_ptr.h:74</div></div>
<div class="ttc" id="aunion____far__ptr_html_seg"><div class="ttname"><a href="union____far__ptr.html#seg">__far_ptr::seg</a></div><div class="ttdeci">uint16_t seg</div><div class="ttdef"><b>Definition:</b> far_ptr.h:77</div></div>
<div class="ttc" id="aunion____far__ptr_html_segfn"><div class="ttname"><a href="union____far__ptr.html#segfn">__far_ptr::segfn</a></div><div class="ttdeci">struct __far_ptr::@8 segfn</div></div>
<div class="ttc" id="aunion____far__ptr_html_segofs"><div class="ttname"><a href="union____far__ptr.html#segofs">__far_ptr::segofs</a></div><div class="ttdeci">struct __far_ptr::@7 segofs</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_aedcfcf321a7f13aa34b51e3093299b2.html">gbdk</a></li><li class="navelem"><a class="el" href="far__ptr_8h.html">far_ptr.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>