git.y1.nz

gbdk-2020

GameBoy Development Kit
download: https://git.y1.nz/archives/gbdk.tar.gz
README | Files | Log | Refs | LICENSE

docs/api/far__ptr_8h.html

      1 <!-- HTML header for doxygen 1.8.14-->
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
      3 <html xmlns="http://www.w3.org/1999/xhtml">
      4 <head>
      5 <meta http-equiv="cache-control" content="max-age=86400"/>
      6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
      7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
      8 <meta name="generator" content="Doxygen 1.9.2"/>
      9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
     10 <title>GBDK 2020 Docs: gbdk-lib/include/gbdk/far_ptr.h File Reference</title>
     11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
     12 <script type="text/javascript" src="jquery.js"></script>
     13 <script type="text/javascript" src="dynsections.js"></script>
     14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
     15 <script type="text/javascript" src="resize.js"></script>
     16 <script type="text/javascript" src="navtreedata.js"></script>
     17 <script type="text/javascript" src="navtree.js"></script>
     18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
     19 <script type="text/javascript" src="search/searchdata.js"></script>
     20 <script type="text/javascript" src="search/search.js"></script>
     21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
     22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
     23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
     24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
     25 <!-- BEGIN: doxygen-awesome-css -->
     26         <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
     27         <script type="text/javascript">
     28             DoxygenAwesomeDarkModeToggle.init()
     29         </script>
     30         <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
     31         <script type="text/javascript">
     32             DoxygenAwesomeParagraphLink.init()
     33         </script>        
     34 <!-- END: doxygen-awesome-css -->
     35 </head>
     36 <body>
     37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
     38 <div id="titlearea">
     39 <table cellspacing="0" cellpadding="0">
     40  <tbody>
     41  <tr style="height: 56px;">
     42   <td id="projectalign" style="padding-left: 0.5em;">
     43    <div id="projectname">GBDK 2020 Docs
     44    &#160;<span id="projectnumber">4.5.0</span>
     45    </div>
     46    <div id="projectbrief">API Documentation for GBDK 2020</div>
     47   </td>
     48  </tr>
     49  </tbody>
     50 </table>
     51 </div>
     52 <!-- end header part -->
     53 <!-- Generated by Doxygen 1.9.2 -->
     54 <script type="text/javascript">
     55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
     56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
     57 /* @license-end */
     58 </script>
     59 <script type="text/javascript" src="menudata.js"></script>
     60 <script type="text/javascript" src="menu.js"></script>
     61 <script type="text/javascript">
     62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
     63 $(function() {
     64   initMenu('',true,false,'search.php','Search');
     65   $(document).ready(function() { init_search(); });
     66 });
     67 /* @license-end */
     68 </script>
     69 <div id="main-nav"></div>
     70 </div><!-- top -->
     71 <div id="side-nav" class="ui-resizable side-nav-resizable">
     72   <div id="nav-tree">
     73     <div id="nav-tree-contents">
     74       <div id="nav-sync" class="sync"></div>
     75     </div>
     76   </div>
     77   <div id="splitbar" style="-moz-user-select:none;" 
     78        class="ui-resizable-handle">
     79   </div>
     80 </div>
     81 <script type="text/javascript">
     82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
     83 $(document).ready(function(){initNavTree('far__ptr_8h.html',''); initResizable(); });
     84 /* @license-end */
     85 </script>
     86 <div id="doc-content">
     87 <!-- window showing the filter options -->
     88 <div id="MSearchSelectWindow"
     89      onmouseover="return searchBox.OnSearchSelectShow()"
     90      onmouseout="return searchBox.OnSearchSelectHide()"
     91      onkeydown="return searchBox.OnSearchSelectKey(event)">
     92 </div>
     93 
     94 <!-- iframe showing the search results (closed by default) -->
     95 <div id="MSearchResultsWindow">
     96 <iframe src="javascript:void(0)" frameborder="0" 
     97         name="MSearchResults" id="MSearchResults">
     98 </iframe>
     99 </div>
    100 
    101 <div class="header">
    102   <div class="summary">
    103 <a href="#nested-classes">Data Structures</a> &#124;
    104 <a href="#define-members">Macros</a> &#124;
    105 <a href="#typedef-members">Typedefs</a> &#124;
    106 <a href="#func-members">Functions</a> &#124;
    107 <a href="#var-members">Variables</a>  </div>
    108   <div class="headertitle"><div class="title">far_ptr.h File Reference</div></div>
    109 </div><!--header-->
    110 <div class="contents">
    111 <div class="textblock"><code>#include &lt;types.h&gt;</code><br />
    112 <code>#include &lt;<a class="el" href="stdint_8h_source.html">stdint.h</a>&gt;</code><br />
    113 </div>
    114 <p><a href="far__ptr_8h_source.html">Go to the source code of this file.</a></p>
    115 <table class="memberdecls">
    116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
    117 Data Structures</h2></td></tr>
    118 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union____far__ptr.html">__far_ptr</a></td></tr>
    119 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
    120 </table><table class="memberdecls">
    121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
    122 Macros</h2></td></tr>
    123 <tr class="memitem:TO_FAR_PTR"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#TO_FAR_PTR">TO_FAR_PTR</a>(ofs,  seg)&#160;&#160;&#160;(((<a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)seg &lt;&lt; 16) | (<a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)ofs)</td></tr>
    124 <tr class="separator:TO_FAR_PTR"><td class="memSeparator" colspan="2">&#160;</td></tr>
    125 <tr class="memitem:FAR_SEG"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#FAR_SEG">FAR_SEG</a>(ptr)&#160;&#160;&#160;(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segofs.seg)</td></tr>
    126 <tr class="separator:FAR_SEG"><td class="memSeparator" colspan="2">&#160;</td></tr>
    127 <tr class="memitem:FAR_OFS"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#FAR_OFS">FAR_OFS</a>(ptr)&#160;&#160;&#160;(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segofs.ofs)</td></tr>
    128 <tr class="separator:FAR_OFS"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129 <tr class="memitem:FAR_FUNC"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#FAR_FUNC">FAR_FUNC</a>(ptr,  typ)&#160;&#160;&#160;((typ)(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segfn.fn))</td></tr>
    130 <tr class="separator:FAR_FUNC"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131 <tr class="memitem:FAR_CALL"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#FAR_CALL">FAR_CALL</a>(ptr,  typ, ...)&#160;&#160;&#160;(<a class="el" href="far__ptr_8h.html#__call_banked_ptr">__call_banked_ptr</a>=ptr,((typ)(&amp;<a class="el" href="far__ptr_8h.html#__call__banked">__call__banked</a>))(__VA_ARGS__))</td></tr>
    132 <tr class="separator:FAR_CALL"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133 </table><table class="memberdecls">
    134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
    135 Typedefs</h2></td></tr>
    136 <tr class="memitem:FAR_PTR"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="stdint_8h.html#uint32_t">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a></td></tr>
    137 <tr class="separator:FAR_PTR"><td class="memSeparator" colspan="2">&#160;</td></tr>
    138 </table><table class="memberdecls">
    139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
    140 Functions</h2></td></tr>
    141 <tr class="memitem:__call__banked"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#__call__banked">__call__banked</a> (void)</td></tr>
    142 <tr class="separator:__call__banked"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143 <tr class="memitem:to_far_ptr"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint32_t">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#to_far_ptr">to_far_ptr</a> (void *ofs, <a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> seg)</td></tr>
    144 <tr class="separator:to_far_ptr"><td class="memSeparator" colspan="2">&#160;</td></tr>
    145 </table><table class="memberdecls">
    146 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
    147 Variables</h2></td></tr>
    148 <tr class="memitem:__call_banked_ptr"><td class="memItemLeft" align="right" valign="top">volatile <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#__call_banked_ptr">__call_banked_ptr</a></td></tr>
    149 <tr class="separator:__call_banked_ptr"><td class="memSeparator" colspan="2">&#160;</td></tr>
    150 <tr class="memitem:__call_banked_addr"><td class="memItemLeft" align="right" valign="top">volatile void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#__call_banked_addr">__call_banked_addr</a></td></tr>
    151 <tr class="separator:__call_banked_addr"><td class="memSeparator" colspan="2">&#160;</td></tr>
    152 <tr class="memitem:__call_banked_bank"><td class="memItemLeft" align="right" valign="top">volatile <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="far__ptr_8h.html#__call_banked_bank">__call_banked_bank</a></td></tr>
    153 <tr class="separator:__call_banked_bank"><td class="memSeparator" colspan="2">&#160;</td></tr>
    154 </table>
    155 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    156 <div class="textblock"><p >Far pointers include a segment (bank) selector so they are able to point to addresses (functions or data) outside of the current bank (unlike normal pointers which are not bank-aware).</p>
    157 <p >See the <code>banks_farptr</code> example project included with gbdk.</p>
    158 <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Add link to a discussion about banking (such as, how to assign code and variables to banks) </dd></dl>
    159 </div><h2 class="groupheader">Macro Definition Documentation</h2>
    160 <a id="TO_FAR_PTR" name="TO_FAR_PTR"></a>
    161 <h2 class="memtitle"><span class="permalink"><a href="#TO_FAR_PTR">&#9670;&nbsp;</a></span>TO_FAR_PTR</h2>
    162 
    163 <div class="memitem">
    164 <div class="memproto">
    165       <table class="memname">
    166         <tr>
    167           <td class="memname">#define TO_FAR_PTR</td>
    168           <td>(</td>
    169           <td class="paramtype">&#160;</td>
    170           <td class="paramname">ofs, </td>
    171         </tr>
    172         <tr>
    173           <td class="paramkey"></td>
    174           <td></td>
    175           <td class="paramtype">&#160;</td>
    176           <td class="paramname">seg&#160;</td>
    177         </tr>
    178         <tr>
    179           <td></td>
    180           <td>)</td>
    181           <td></td><td>&#160;&#160;&#160;(((<a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)seg &lt;&lt; 16) | (<a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)ofs)</td>
    182         </tr>
    183       </table>
    184 </div><div class="memdoc">
    185 <p >Macro to obtain a far pointer at compile-time </p><dl class="params"><dt>Parameters</dt><dd>
    186   <table class="params">
    187     <tr><td class="paramname">ofs</td><td>Memory address within the given Segment (Bank) </td></tr>
    188     <tr><td class="paramname">seg</td><td>Segment (Bank) number</td></tr>
    189   </table>
    190   </dd>
    191 </dl>
    192 <dl class="section return"><dt>Returns</dt><dd>A far pointer (type <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>) </dd></dl>
    193 
    194 </div>
    195 </div>
    196 <a id="FAR_SEG" name="FAR_SEG"></a>
    197 <h2 class="memtitle"><span class="permalink"><a href="#FAR_SEG">&#9670;&nbsp;</a></span>FAR_SEG</h2>
    198 
    199 <div class="memitem">
    200 <div class="memproto">
    201       <table class="memname">
    202         <tr>
    203           <td class="memname">#define FAR_SEG</td>
    204           <td>(</td>
    205           <td class="paramtype">&#160;</td>
    206           <td class="paramname">ptr</td><td>)</td>
    207           <td>&#160;&#160;&#160;(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segofs.seg)</td>
    208         </tr>
    209       </table>
    210 </div><div class="memdoc">
    211 <p >Macro to get the Segment (Bank) number of a far pointer </p><dl class="params"><dt>Parameters</dt><dd>
    212   <table class="params">
    213     <tr><td class="paramname">ptr</td><td>A far pointer (type <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)</td></tr>
    214   </table>
    215   </dd>
    216 </dl>
    217 <dl class="section return"><dt>Returns</dt><dd>Segment (Bank) of the far pointer (type uint16_t) </dd></dl>
    218 
    219 </div>
    220 </div>
    221 <a id="FAR_OFS" name="FAR_OFS"></a>
    222 <h2 class="memtitle"><span class="permalink"><a href="#FAR_OFS">&#9670;&nbsp;</a></span>FAR_OFS</h2>
    223 
    224 <div class="memitem">
    225 <div class="memproto">
    226       <table class="memname">
    227         <tr>
    228           <td class="memname">#define FAR_OFS</td>
    229           <td>(</td>
    230           <td class="paramtype">&#160;</td>
    231           <td class="paramname">ptr</td><td>)</td>
    232           <td>&#160;&#160;&#160;(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segofs.ofs)</td>
    233         </tr>
    234       </table>
    235 </div><div class="memdoc">
    236 <p >Macro to get the Offset (address) of a far pointer </p><dl class="params"><dt>Parameters</dt><dd>
    237   <table class="params">
    238     <tr><td class="paramname">ptr</td><td>A far pointer (type <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>)</td></tr>
    239   </table>
    240   </dd>
    241 </dl>
    242 <dl class="section return"><dt>Returns</dt><dd>Offset (address) of the far pointer (type void *) </dd></dl>
    243 
    244 </div>
    245 </div>
    246 <a id="FAR_FUNC" name="FAR_FUNC"></a>
    247 <h2 class="memtitle"><span class="permalink"><a href="#FAR_FUNC">&#9670;&nbsp;</a></span>FAR_FUNC</h2>
    248 
    249 <div class="memitem">
    250 <div class="memproto">
    251       <table class="memname">
    252         <tr>
    253           <td class="memname">#define FAR_FUNC</td>
    254           <td>(</td>
    255           <td class="paramtype">&#160;</td>
    256           <td class="paramname">ptr, </td>
    257         </tr>
    258         <tr>
    259           <td class="paramkey"></td>
    260           <td></td>
    261           <td class="paramtype">&#160;</td>
    262           <td class="paramname">typ&#160;</td>
    263         </tr>
    264         <tr>
    265           <td></td>
    266           <td>)</td>
    267           <td></td><td>&#160;&#160;&#160;((typ)(((union <a class="el" href="union____far__ptr.html">__far_ptr</a> *)&amp;ptr)-&gt;segfn.fn))</td>
    268         </tr>
    269       </table>
    270 </div><div class="memdoc">
    271 
    272 </div>
    273 </div>
    274 <a id="FAR_CALL" name="FAR_CALL"></a>
    275 <h2 class="memtitle"><span class="permalink"><a href="#FAR_CALL">&#9670;&nbsp;</a></span>FAR_CALL</h2>
    276 
    277 <div class="memitem">
    278 <div class="memproto">
    279       <table class="memname">
    280         <tr>
    281           <td class="memname">#define FAR_CALL</td>
    282           <td>(</td>
    283           <td class="paramtype">&#160;</td>
    284           <td class="paramname">ptr, </td>
    285         </tr>
    286         <tr>
    287           <td class="paramkey"></td>
    288           <td></td>
    289           <td class="paramtype">&#160;</td>
    290           <td class="paramname">typ, </td>
    291         </tr>
    292         <tr>
    293           <td class="paramkey"></td>
    294           <td></td>
    295           <td class="paramtype">&#160;</td>
    296           <td class="paramname"><em>...</em>&#160;</td>
    297         </tr>
    298         <tr>
    299           <td></td>
    300           <td>)</td>
    301           <td></td><td>&#160;&#160;&#160;(<a class="el" href="far__ptr_8h.html#__call_banked_ptr">__call_banked_ptr</a>=ptr,((typ)(&amp;<a class="el" href="far__ptr_8h.html#__call__banked">__call__banked</a>))(__VA_ARGS__))</td>
    302         </tr>
    303       </table>
    304 </div><div class="memdoc">
    305 <p >Macro to call a function at far pointer <b>ptr</b> of type <b>typ</b> </p><dl class="params"><dt>Parameters</dt><dd>
    306   <table class="params">
    307     <tr><td class="paramname">ptr</td><td>Far pointer of a function to call (type <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>) </td></tr>
    308     <tr><td class="paramname">typ</td><td>Type to cast the function far pointer to. </td></tr>
    309     <tr><td class="paramname">...</td><td>VA Args list of parameters for the function</td></tr>
    310   </table>
    311   </dd>
    312 </dl>
    313 <p><b>type</b> should match the definition of the function being called. For example: </p><div class="fragment"><div class="line"><span class="comment">// A function in bank 2</span></div>
    314 <div class="line"><span class="preprocessor">#pragma bank 2</span></div>
    315 <div class="line"><a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> some_function(<a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> param1, <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> param2) __banked {  <span class="keywordflow">return</span> 1; };</div>
    316 <div class="line"> </div>
    317 <div class="line">...</div>
    318 <div class="line"><span class="comment">// Code elsewhere, such as unbanked main()</span></div>
    319 <div class="line"><span class="comment">// This type declaration should match the above function</span></div>
    320 <div class="line">typedef <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a> (*some_function_t)(<a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a>, <a class="code hl_typedef" href="stdint_8h.html#uint16_t">uint16_t</a>) __banked;</div>
    321 <div class="line"> </div>
    322 <div class="line"><span class="comment">// Using FAR_CALL() with the above as *ptr*, *typ*, and two parameters.</span></div>
    323 <div class="line">result = <a class="code hl_define" href="far__ptr_8h.html#FAR_CALL">FAR_CALL</a>(some_function, some_function_t, 100, 50);</div>
    324 <div class="ttc" id="afar__ptr_8h_html_FAR_CALL"><div class="ttname"><a href="far__ptr_8h.html#FAR_CALL">FAR_CALL</a></div><div class="ttdeci">#define FAR_CALL(ptr, typ,...)</div><div class="ttdef"><b>Definition:</b> far_ptr.h:65</div></div>
    325 <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>
    326 </div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>Value returned by the function (if present) </dd></dl>
    327 
    328 </div>
    329 </div>
    330 <h2 class="groupheader">Typedef Documentation</h2>
    331 <a id="FAR_PTR" name="FAR_PTR"></a>
    332 <h2 class="memtitle"><span class="permalink"><a href="#FAR_PTR">&#9670;&nbsp;</a></span>FAR_PTR</h2>
    333 
    334 <div class="memitem">
    335 <div class="memproto">
    336       <table class="memname">
    337         <tr>
    338           <td class="memname">typedef <a class="el" href="stdint_8h.html#uint32_t">uint32_t</a> <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a></td>
    339         </tr>
    340       </table>
    341 </div><div class="memdoc">
    342 <p >Type for storing a FAR_PTR </p>
    343 
    344 </div>
    345 </div>
    346 <h2 class="groupheader">Function Documentation</h2>
    347 <a id="__call__banked" name="__call__banked"></a>
    348 <h2 class="memtitle"><span class="permalink"><a href="#__call__banked">&#9670;&nbsp;</a></span>__call__banked()</h2>
    349 
    350 <div class="memitem">
    351 <div class="memproto">
    352       <table class="memname">
    353         <tr>
    354           <td class="memname">void __call__banked </td>
    355           <td>(</td>
    356           <td class="paramtype">void&#160;</td>
    357           <td class="paramname"></td><td>)</td>
    358           <td></td>
    359         </tr>
    360       </table>
    361 </div><div class="memdoc">
    362 
    363 </div>
    364 </div>
    365 <a id="to_far_ptr" name="to_far_ptr"></a>
    366 <h2 class="memtitle"><span class="permalink"><a href="#to_far_ptr">&#9670;&nbsp;</a></span>to_far_ptr()</h2>
    367 
    368 <div class="memitem">
    369 <div class="memproto">
    370       <table class="memname">
    371         <tr>
    372           <td class="memname"><a class="el" href="stdint_8h.html#uint32_t">uint32_t</a> to_far_ptr </td>
    373           <td>(</td>
    374           <td class="paramtype">void *&#160;</td>
    375           <td class="paramname"><em>ofs</em>, </td>
    376         </tr>
    377         <tr>
    378           <td class="paramkey"></td>
    379           <td></td>
    380           <td class="paramtype"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a>&#160;</td>
    381           <td class="paramname"><em>seg</em>&#160;</td>
    382         </tr>
    383         <tr>
    384           <td></td>
    385           <td>)</td>
    386           <td></td><td></td>
    387         </tr>
    388       </table>
    389 </div><div class="memdoc">
    390 <p >Obtain a far pointer at runtime </p><dl class="params"><dt>Parameters</dt><dd>
    391   <table class="params">
    392     <tr><td class="paramname">ofs</td><td>Memory address within the given Segment (Bank) </td></tr>
    393     <tr><td class="paramname">seg</td><td>Segment (Bank) number</td></tr>
    394   </table>
    395   </dd>
    396 </dl>
    397 <dl class="section return"><dt>Returns</dt><dd>A far pointer (type <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a>) </dd></dl>
    398 
    399 </div>
    400 </div>
    401 <h2 class="groupheader">Variable Documentation</h2>
    402 <a id="__call_banked_ptr" name="__call_banked_ptr"></a>
    403 <h2 class="memtitle"><span class="permalink"><a href="#__call_banked_ptr">&#9670;&nbsp;</a></span>__call_banked_ptr</h2>
    404 
    405 <div class="memitem">
    406 <div class="memproto">
    407 <table class="mlabels">
    408   <tr>
    409   <td class="mlabels-left">
    410       <table class="memname">
    411         <tr>
    412           <td class="memname">volatile <a class="el" href="far__ptr_8h.html#FAR_PTR">FAR_PTR</a> __call_banked_ptr</td>
    413         </tr>
    414       </table>
    415   </td>
    416   <td class="mlabels-right">
    417 <span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    418   </tr>
    419 </table>
    420 </div><div class="memdoc">
    421 
    422 </div>
    423 </div>
    424 <a id="__call_banked_addr" name="__call_banked_addr"></a>
    425 <h2 class="memtitle"><span class="permalink"><a href="#__call_banked_addr">&#9670;&nbsp;</a></span>__call_banked_addr</h2>
    426 
    427 <div class="memitem">
    428 <div class="memproto">
    429 <table class="mlabels">
    430   <tr>
    431   <td class="mlabels-left">
    432       <table class="memname">
    433         <tr>
    434           <td class="memname">volatile void* __call_banked_addr</td>
    435         </tr>
    436       </table>
    437   </td>
    438   <td class="mlabels-right">
    439 <span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    440   </tr>
    441 </table>
    442 </div><div class="memdoc">
    443 
    444 </div>
    445 </div>
    446 <a id="__call_banked_bank" name="__call_banked_bank"></a>
    447 <h2 class="memtitle"><span class="permalink"><a href="#__call_banked_bank">&#9670;&nbsp;</a></span>__call_banked_bank</h2>
    448 
    449 <div class="memitem">
    450 <div class="memproto">
    451 <table class="mlabels">
    452   <tr>
    453   <td class="mlabels-left">
    454       <table class="memname">
    455         <tr>
    456           <td class="memname">volatile <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> __call_banked_bank</td>
    457         </tr>
    458       </table>
    459   </td>
    460   <td class="mlabels-right">
    461 <span class="mlabels"><span class="mlabel">extern</span></span>  </td>
    462   </tr>
    463 </table>
    464 </div><div class="memdoc">
    465 
    466 </div>
    467 </div>
    468 </div><!-- contents -->
    469 </div><!-- doc-content -->
    470 <!-- start footer part -->
    471 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    472   <ul>
    473     <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>
    474     <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>
    475   </ul>
    476 </div>
    477 </body>
    478 </html>

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.