mirror of
https://github.com/zoriya/ComSquare.git
synced 2026-06-13 22:35:13 +00:00
AnonymusRaccoon
145 lines
19 KiB
HTML
145 lines
19 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/Ram/Ram.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_96c90ef27c711de2cda20e988f4ab9d6.html">Ram</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Ram.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="Ram_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/28/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 "<a class="code" href="ARectangleMemory_8hpp.html">Memory/ARectangleMemory.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <span></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Ram.html">ComSquare::Ram</a></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classComSquare_1_1Ram_1_1Ram.html"> 14</a></span>  <span class="keyword">class </span><a class="code" href="classComSquare_1_1Ram_1_1Ram.html">Ram</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html">Memory::ARectangleMemory</a></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classComSquare_1_1Ram_1_1Ram.html#a4c4fc2604f010903a00a091e12cf0378"> 18</a></span>  std::vector<uint8_t> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a4c4fc2604f010903a00a091e12cf0378">_data</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classComSquare_1_1Ram_1_1Ram.html#a28a7867b95ceb57d7a97ba046e8ca14f"> 20</a></span>  <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a28a7867b95ceb57d7a97ba046e8ca14f">_ramType</a>;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classComSquare_1_1Ram_1_1Ram.html#a3c0780f64fe626ba63e4d123ad9eaeef"> 22</a></span>  std::string <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a3c0780f64fe626ba63e4d123ad9eaeef">_ramName</a>;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">explicit</span> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a71d3876ff028ef14396f93bb91df4b12">Ram</a>(<span class="keywordtype">size_t</span> size, <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a>, std::string ramName);</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a71d3876ff028ef14396f93bb91df4b12">Ram</a>(<span class="keyword">const</span> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html">Ram</a> &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classComSquare_1_1Ram_1_1Ram.html">Ram</a> &<a class="code" href="classComSquare_1_1Ram_1_1Ram.html#ac27ae4f0c92ee9f14d307eea4e7f5a9f">operator=</a>(<a class="code" href="classComSquare_1_1Ram_1_1Ram.html">Ram</a> &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a28b5b266c8ea7103eee1ac50b2acfe45">~Ram</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint8_t <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a873f2becaa9b63d8864bb43eaae89fc6">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="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a0f42b342ebf151574c1e523719f9cf52">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="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint8_t &<a class="code" href="classComSquare_1_1Ram_1_1Ram.html#ac5ffc8d4eb97d6a1b0650eba97234fbb">operator[]</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> uint8_t &<a class="code" href="classComSquare_1_1Ram_1_1Ram.html#ac5ffc8d4eb97d6a1b0650eba97234fbb">operator[]</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  [[nodiscard]] std::string <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a71d2424b05cf638d04402db2260c71aa">getName</a>() <span class="keyword">const override</span>;</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>  [[nodiscard]] <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a80af60fecd948b647d590435028ecf1f">getComponent</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a003803dabc201990c870f5405c7e6de1">getSize</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#a73c5c7970f12f28444d1afcc846c61ed">setSize</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> size);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  [[nodiscard]] std::span<uint8_t> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#ac43d5eb08820d5a71a29275db8c95385">getData</a>();</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  [[nodiscard]] std::span<const uint8_t> <a class="code" href="classComSquare_1_1Ram_1_1Ram.html#ac43d5eb08820d5a71a29275db8c95385">getData</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  };</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html">ComSquare::Ram::Ram</a></div><div class="ttdef"><b>Definition:</b> Ram.hpp:14</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_1_1Ram_html"><div class="ttname"><a href="namespaceComSquare_1_1Ram.html">ComSquare::Ram</a></div><div class="ttdef"><b>Definition:</b> Ram.cpp:10</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_1Ram_1_1Ram_html_a28b5b266c8ea7103eee1ac50b2acfe45"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a28b5b266c8ea7103eee1ac50b2acfe45">ComSquare::Ram::Ram::~Ram</a></div><div class="ttdeci">~Ram() override=default</div><div class="ttdoc">Destructor that free the ram.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ComSquare::Memory::ARectangleMemory</a></div><div class="ttdoc">Base memory class to map non continuous rectangle to the memory. (A rectangle that spam across more t...</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:13</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_ac43d5eb08820d5a71a29275db8c95385"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#ac43d5eb08820d5a71a29275db8c95385">ComSquare::Ram::Ram::getData</a></div><div class="ttdeci">std::span< uint8_t > getData()</div><div class="ttdoc">Get the raw data of the RAM.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:63</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="aARectangleMemory_8hpp_html"><div class="ttname"><a href="ARectangleMemory_8hpp.html">ARectangleMemory.hpp</a></div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a4c4fc2604f010903a00a091e12cf0378"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a4c4fc2604f010903a00a091e12cf0378">ComSquare::Ram::Ram::_data</a></div><div class="ttdeci">std::vector< uint8_t > _data</div><div class="ttdoc">The ram. (Can be used for WRam, SRam, VRam etc)</div><div class="ttdef"><b>Definition:</b> Ram.hpp:18</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a71d2424b05cf638d04402db2260c71aa"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a71d2424b05cf638d04402db2260c71aa">ComSquare::Ram::Ram::getName</a></div><div class="ttdeci">std::string getName() const override</div><div class="ttdoc">Get the name of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> Ram.cpp:53</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a28a7867b95ceb57d7a97ba046e8ca14f"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a28a7867b95ceb57d7a97ba046e8ca14f">ComSquare::Ram::Ram::_ramType</a></div><div class="ttdeci">Component _ramType</div><div class="ttdoc">An id identifying the type of memory this is (for the debugger)</div><div class="ttdef"><b>Definition:</b> Ram.hpp:20</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a80af60fecd948b647d590435028ecf1f"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a80af60fecd948b647d590435028ecf1f">ComSquare::Ram::Ram::getComponent</a></div><div class="ttdeci">Component getComponent() const override</div><div class="ttdoc">Get the component of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> Ram.cpp:58</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a73c5c7970f12f28444d1afcc846c61ed"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a73c5c7970f12f28444d1afcc846c61ed">ComSquare::Ram::Ram::setSize</a></div><div class="ttdeci">void setSize(uint24_t size)</div><div class="ttdoc">Change the size of this ram.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:48</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a003803dabc201990c870f5405c7e6de1"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a003803dabc201990c870f5405c7e6de1">ComSquare::Ram::Ram::getSize</a></div><div class="ttdeci">uint24_t getSize() const override</div><div class="ttdoc">Get the size of the ram in bytes.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:43</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_ac5ffc8d4eb97d6a1b0650eba97234fbb"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#ac5ffc8d4eb97d6a1b0650eba97234fbb">ComSquare::Ram::Ram::operator[]</a></div><div class="ttdeci">uint8_t & operator[](uint24_t addr)</div><div class="ttdoc">Retrieve the data at the address given. This can be used instead of read or write.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:18</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_ac27ae4f0c92ee9f14d307eea4e7f5a9f"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#ac27ae4f0c92ee9f14d307eea4e7f5a9f">ComSquare::Ram::Ram::operator=</a></div><div class="ttdeci">Ram & operator=(Ram &)=delete</div><div class="ttdoc">The ram can't be assigned.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a3c0780f64fe626ba63e4d123ad9eaeef"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a3c0780f64fe626ba63e4d123ad9eaeef">ComSquare::Ram::Ram::_ramName</a></div><div class="ttdeci">std::string _ramName</div><div class="ttdoc">The name of this ram.</div><div class="ttdef"><b>Definition:</b> Ram.hpp:22</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a0f42b342ebf151574c1e523719f9cf52"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a0f42b342ebf151574c1e523719f9cf52">ComSquare::Ram::Ram::write</a></div><div class="ttdeci">void write(uint24_t addr, uint8_t data) override</div><div class="ttdoc">Write data to this component.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:36</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a71d3876ff028ef14396f93bb91df4b12"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a71d3876ff028ef14396f93bb91df4b12">ComSquare::Ram::Ram::Ram</a></div><div class="ttdeci">Ram(size_t size, Component, std::string ramName)</div><div class="ttdoc">Create a ram of a given size in bytes.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:12</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Ram_1_1Ram_html_a873f2becaa9b63d8864bb43eaae89fc6"><div class="ttname"><a href="classComSquare_1_1Ram_1_1Ram.html#a873f2becaa9b63d8864bb43eaae89fc6">ComSquare::Ram::Ram::read</a></div><div class="ttdeci">uint8_t read(uint24_t addr) override</div><div class="ttdoc">Read data from the component.</div><div class="ttdef"><b>Definition:</b> Ram.cpp:28</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>
|