mirror of
https://github.com/zoriya/ComSquare.git
synced 2026-05-10 10:01:23 +00:00
132 lines
14 KiB
HTML
132 lines
14 KiB
HTML
<!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/IMemory.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&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&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">IMemory.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="IMemory_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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by anonymus-raccoon on 1/23/20.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <cstdint></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="Ints_8hpp.html">Models/Ints.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="Components_8hpp.html">Models/Components.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1IMemory.html"> 17</a></span>  <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a8459ed12c4172ee29ecdc84330f99ff7">read</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) = 0;</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a449bc89798a0b86028bb0413106514d9">write</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) = 0;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a6b7cf04f893b04b9b063759ad67d5bff">hasMemoryAt</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a44a24003df048c5e832ba23722ef026d">getRelativeAddress</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a1072ab44e7389913ff67cb77ff118c8b">getSize</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> std::string <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a34d654c04a8a992b439c4270d566263f">getName</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a31289443bb26086fb74c724cdafd2241">getComponent</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> std::string <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a1f02b894a85d7b1a0b8bae677039d821">getValueName</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html#a0a0679f3cf924e3562d6f89a80aae069">~IMemory</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  };</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aInts_8hpp_html"><div class="ttname"><a href="Ints_8hpp.html">Ints.hpp</a></div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a0a0679f3cf924e3562d6f89a80aae069"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a0a0679f3cf924e3562d6f89a80aae069">ComSquare::Memory::IMemory::~IMemory</a></div><div class="ttdeci">virtual ~IMemory()=default</div><div class="ttdoc">A virtual default destructor.</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_html_a891b49feb5c3e0aaa4873ff19b49968c"><div class="ttname"><a href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">ComSquare::Component</a></div><div class="ttdeci">Component</div><div class="ttdef"><b>Definition:</b> Components.hpp:9</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a8459ed12c4172ee29ecdc84330f99ff7"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a8459ed12c4172ee29ecdc84330f99ff7">ComSquare::Memory::IMemory::read</a></div><div class="ttdeci">virtual uint8_t read(uint24_t addr)=0</div><div class="ttdoc">Read data from the component.</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:10</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:17</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a1072ab44e7389913ff67cb77ff118c8b"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a1072ab44e7389913ff67cb77ff118c8b">ComSquare::Memory::IMemory::getSize</a></div><div class="ttdeci">virtual uint24_t getSize() const =0</div><div class="ttdoc">Get the size of the data. This size can be lower than the mapped data.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a34d654c04a8a992b439c4270d566263f"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a34d654c04a8a992b439c4270d566263f">ComSquare::Memory::IMemory::getName</a></div><div class="ttdeci">virtual std::string getName() const =0</div><div class="ttdoc">Get the name of this accessor (used for debug purpose)</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a31289443bb26086fb74c724cdafd2241"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a31289443bb26086fb74c724cdafd2241">ComSquare::Memory::IMemory::getComponent</a></div><div class="ttdeci">virtual Component getComponent() const =0</div><div class="ttdoc">Get the component of this accessor (used for debug purpose)</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a44a24003df048c5e832ba23722ef026d"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a44a24003df048c5e832ba23722ef026d">ComSquare::Memory::IMemory::getRelativeAddress</a></div><div class="ttdeci">virtual uint24_t getRelativeAddress(uint24_t addr) const =0</div><div class="ttdoc">Translate an absolute address to a relative address.</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> AMemory.cpp:7</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a1f02b894a85d7b1a0b8bae677039d821"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a1f02b894a85d7b1a0b8bae677039d821">ComSquare::Memory::IMemory::getValueName</a></div><div class="ttdeci">virtual std::string getValueName(uint24_t addr) const =0</div><div class="ttdoc">Get the name of the data at the address.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a449bc89798a0b86028bb0413106514d9"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a449bc89798a0b86028bb0413106514d9">ComSquare::Memory::IMemory::write</a></div><div class="ttdeci">virtual void write(uint24_t addr, uint8_t data)=0</div><div class="ttdoc">Write data to this component.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html_a6b7cf04f893b04b9b063759ad67d5bff"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html#a6b7cf04f893b04b9b063759ad67d5bff">ComSquare::Memory::IMemory::hasMemoryAt</a></div><div class="ttdeci">virtual bool hasMemoryAt(uint24_t addr) const =0</div><div class="ttdoc">Return true if this component has mapped the address.</div></div>
|
|
<div class="ttc" id="aComponents_8hpp_html"><div class="ttname"><a href="Components_8hpp.html">Components.hpp</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|