zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-18 21:06:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
916de992f960c59658aa65e1341ecc8fda069006
ComSquare/docs/IRectangleMemory_8hpp_source.html
T
AnonymusRaccoon 4fede95154 Moving the html docs to the docs/ root
2020-01-31 16:52:04 +01:00

127 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ComSquare: sources/Memory/IRectangleMemory.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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">ComSquare
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_b6b0f0b7471b46e8c4cfc0f00c8af2f6.html">Memory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">IRectangleMemory.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="IRectangleMemory_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by anonymus-raccoon on 1/29/20.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef COMSQUARE_IRECTANGLEMEMORY_HPP</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define COMSQUARE_IRECTANGLEMEMORY_HPP</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IMemory_8hpp.html">IMemory.hpp</a>&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IRectangleMemory.html"> 14</a></span>&#160; <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html">IRectangleMemory</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a94658df7460fd7f9f59f22955d93bf6b"> 17</a></span>&#160; uint8_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a94658df7460fd7f9f59f22955d93bf6b">_startBank</a> = 0;</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#acc2002b644d61a7dc4d40c92e0b93a3d"> 19</a></span>&#160; uint8_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#acc2002b644d61a7dc4d40c92e0b93a3d">_endBank</a> = 0;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a9178184277528ac54064ca6caacab474"> 21</a></span>&#160; uint16_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a9178184277528ac54064ca6caacab474">_startPage</a> = 0;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#aece911d747bb326279bc7e661e06a9a3"> 23</a></span>&#160; uint16_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#aece911d747bb326279bc7e661e06a9a3">_endPage</a> = 0;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; uint8_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a478251bc0c7272712b6f6f25aa17b71a">read</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a54b0ace13a17556f6072399ffed9b817">write</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a2a239baa265b31e222d4e5b0a9d2d5e0">read_internal</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) = 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#ac37e86292b5e7b0bd099757c2e6263cc">write_internal</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) = 0;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#ab165286db6b6c7cea0e635ca49a07824">hasMemoryAt</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a6b55c812fb38ed7c67d19f32748b5286">getStart</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a90bb7d98b2e8c2da70cc29c36ac70adc">setMemoryRegion</a>(uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif //COMSQUARE_IRECTANGLEMEMORY_HPP</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html">ComSquare::Memory::IRectangleMemory</a></div><div class="ttdoc">Superset of the IMemory to map non continuous rectangle to the memory. (A rectangle that spam across ...</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.hpp:14</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a94658df7460fd7f9f59f22955d93bf6b"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a94658df7460fd7f9f59f22955d93bf6b">ComSquare::Memory::IRectangleMemory::_startBank</a></div><div class="ttdeci">uint8_t _startBank</div><div class="ttdoc">The first bank to map to.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.hpp:17</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a478251bc0c7272712b6f6f25aa17b71a"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a478251bc0c7272712b6f6f25aa17b71a">ComSquare::Memory::IRectangleMemory::read</a></div><div class="ttdeci">uint8_t read(uint24_t addr) override</div><div class="ttdoc">Read data from the component using the same method as the basic IMemory.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.cpp:10</div></div>
<div class="ttc" id="aInts_8hpp_html_a89f009aaf5d1964a000f44f09fa0bcf8"><div class="ttname"><a href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a></div><div class="ttdeci">unsigned uint24_t</div><div class="ttdef"><b>Definition:</b> Ints.hpp:8</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html">ComSquare::Memory::IMemory</a></div><div class="ttdoc">Common interface implemented by all components mapping memory.</div><div class="ttdef"><b>Definition:</b> IMemory.hpp:16</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a6b55c812fb38ed7c67d19f32748b5286"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a6b55c812fb38ed7c67d19f32748b5286">ComSquare::Memory::IRectangleMemory::getStart</a></div><div class="ttdeci">uint24_t getStart() override</div><div class="ttdoc">Get the first address mapped to this component.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.cpp:53</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a54b0ace13a17556f6072399ffed9b817"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a54b0ace13a17556f6072399ffed9b817">ComSquare::Memory::IRectangleMemory::write</a></div><div class="ttdeci">void write(uint24_t addr, uint8_t data) override</div><div class="ttdoc">Write data to this component using the same method as the basic IMemory.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.cpp:26</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a2a239baa265b31e222d4e5b0a9d2d5e0"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a2a239baa265b31e222d4e5b0a9d2d5e0">ComSquare::Memory::IRectangleMemory::read_internal</a></div><div class="ttdeci">virtual uint8_t read_internal(uint24_t addr)=0</div><div class="ttdoc">Internal component read. Implement this as you would implement a basic IMemory's read.</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a90bb7d98b2e8c2da70cc29c36ac70adc"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a90bb7d98b2e8c2da70cc29c36ac70adc">ComSquare::Memory::IRectangleMemory::setMemoryRegion</a></div><div class="ttdeci">void setMemoryRegion(uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage)</div><div class="ttdoc">Change starting and ending points of this mapped memory.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.cpp:58</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_a9178184277528ac54064ca6caacab474"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#a9178184277528ac54064ca6caacab474">ComSquare::Memory::IRectangleMemory::_startPage</a></div><div class="ttdeci">uint16_t _startPage</div><div class="ttdoc">The first address of each bank to map.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.hpp:21</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_aece911d747bb326279bc7e661e06a9a3"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#aece911d747bb326279bc7e661e06a9a3">ComSquare::Memory::IRectangleMemory::_endPage</a></div><div class="ttdeci">uint16_t _endPage</div><div class="ttdoc">The last address of each bank to map.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.hpp:23</div></div>
<div class="ttc" id="anamespaceComSquare_1_1Memory_html"><div class="ttname"><a href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div><div class="ttdef"><b>Definition:</b> IMemory.cpp:8</div></div>
<div class="ttc" id="aIMemory_8hpp_html"><div class="ttname"><a href="IMemory_8hpp.html">IMemory.hpp</a></div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_ac37e86292b5e7b0bd099757c2e6263cc"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#ac37e86292b5e7b0bd099757c2e6263cc">ComSquare::Memory::IRectangleMemory::write_internal</a></div><div class="ttdeci">virtual void write_internal(uint24_t addr, uint8_t data)=0</div><div class="ttdoc">Internal component write. Implement this as you would implement a basic IMemory's write.</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_ab165286db6b6c7cea0e635ca49a07824"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#ab165286db6b6c7cea0e635ca49a07824">ComSquare::Memory::IRectangleMemory::hasMemoryAt</a></div><div class="ttdeci">bool hasMemoryAt(uint24_t addr) override</div><div class="ttdoc">Return true if this component has mapped the address.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.cpp:42</div></div>
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IRectangleMemory_html_acc2002b644d61a7dc4d40c92e0b93a3d"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IRectangleMemory.html#acc2002b644d61a7dc4d40c92e0b93a3d">ComSquare::Memory::IRectangleMemory::_endBank</a></div><div class="ttdeci">uint8_t _endBank</div><div class="ttdoc">The last bank to map to.</div><div class="ttdef"><b>Definition:</b> IRectangleMemory.hpp:19</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink