zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-13 03:15:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
ComSquare/classComSquare_1_1Memory_1_1IMemoryBus.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

359 lines
19 KiB
HTML
Raw Permalink 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: ComSquare::Memory::IMemoryBus Class Reference</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="namespaceComSquare.html">ComSquare</a></li><li class="navelem"><a class="el" href="namespaceComSquare_1_1Memory.html">Memory</a></li><li class="navelem"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html">IMemoryBus</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classComSquare_1_1Memory_1_1IMemoryBus-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Memory::IMemoryBus Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The memory bus is the component responsible of mapping addresses to components address and transmitting the data.
<a href="classComSquare_1_1Memory_1_1IMemoryBus.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IMemoryBus_8hpp_source.html">IMemoryBus.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ComSquare::Memory::IMemoryBus:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1IMemoryBus__inherit__graph.svg" width="384" height="507"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for ComSquare::Memory::IMemoryBus:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1IMemoryBus__coll__graph.svg" width="178" height="176"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5538f7e281f45053245a4036473a5e46"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a5538f7e281f45053245a4036473a5e46">~IMemoryBus</a> ()=default</td></tr>
<tr class="memdesc:a5538f7e281f45053245a4036473a5e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual default destructor. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#a5538f7e281f45053245a4036473a5e46">More...</a><br /></td></tr>
<tr class="separator:a5538f7e281f45053245a4036473a5e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a560cf44b01d039ac4e13762e2abf46b1"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a560cf44b01d039ac4e13762e2abf46b1">read</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)=0</td></tr>
<tr class="memdesc:a560cf44b01d039ac4e13762e2abf46b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data at a global address. This form allow read to be silenced. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#a560cf44b01d039ac4e13762e2abf46b1">More...</a><br /></td></tr>
<tr class="separator:a560cf44b01d039ac4e13762e2abf46b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a715161996b7842c55c0be82d3cd22572"><td class="memItemLeft" align="right" valign="top">virtual std::optional&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a715161996b7842c55c0be82d3cd22572">peek</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)=0</td></tr>
<tr class="memdesc:a715161996b7842c55c0be82d3cd22572"><td class="mdescLeft">&#160;</td><td class="mdescRight">This as the same purpose as a read but it does not change the open bus and won't throw an exception. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#a715161996b7842c55c0be82d3cd22572">More...</a><br /></td></tr>
<tr class="separator:a715161996b7842c55c0be82d3cd22572"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a474f556b1f4ef4af276217a489031775"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a474f556b1f4ef4af276217a489031775">peek_v</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)=0</td></tr>
<tr class="memdesc:a474f556b1f4ef4af276217a489031775"><td class="mdescLeft">&#160;</td><td class="mdescRight">This as the same purpose as a read but it does not change the open bus and won't throw an exception. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#a474f556b1f4ef4af276217a489031775">More...</a><br /></td></tr>
<tr class="separator:a474f556b1f4ef4af276217a489031775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a393b05cf83c6dc1ee6c0cad9648cb31b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a393b05cf83c6dc1ee6c0cad9648cb31b">write</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data)=0</td></tr>
<tr class="memdesc:a393b05cf83c6dc1ee6c0cad9648cb31b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a data to a global address. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#a393b05cf83c6dc1ee6c0cad9648cb31b">More...</a><br /></td></tr>
<tr class="separator:a393b05cf83c6dc1ee6c0cad9648cb31b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0ab5473f22b232b701a7fc101f4489b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#ad0ab5473f22b232b701a7fc101f4489b">getAccessor</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)=0</td></tr>
<tr class="memdesc:ad0ab5473f22b232b701a7fc101f4489b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to get the components that is responsible of read/write at an address. <a href="classComSquare_1_1Memory_1_1IMemoryBus.html#ad0ab5473f22b232b701a7fc101f4489b">More...</a><br /></td></tr>
<tr class="separator:ad0ab5473f22b232b701a7fc101f4489b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The memory bus is the component responsible of mapping addresses to components address and transmitting the data. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5538f7e281f45053245a4036473a5e46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5538f7e281f45053245a4036473a5e46">&#9670;&nbsp;</a></span>~IMemoryBus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ComSquare::Memory::IMemoryBus::~IMemoryBus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A virtual default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0ab5473f22b232b701a7fc101f4489b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0ab5473f22b232b701a7fc101f4489b">&#9670;&nbsp;</a></span>getAccessor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a>* ComSquare::Memory::IMemoryBus::getAccessor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function to get the components that is responsible of read/write at an address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address you want to look for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The components responsible for the address param or nullptr if none was found. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1Debugger_1_1MemoryBusDebug.html#a4b082fcada287cf8cd0a58dc1447412e">ComSquare::Debugger::MemoryBusDebug</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#acd9f28fab89e9c3b46571f049f37a0c3">ComSquare::Memory::MemoryBus</a>.</p>
</div>
</div>
<a id="a715161996b7842c55c0be82d3cd22572"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a715161996b7842c55c0be82d3cd22572">&#9670;&nbsp;</a></span>peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::optional&lt;uint8_t&gt; ComSquare::Memory::IMemoryBus::peek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This as the same purpose as a read but it does not change the open bus and won't throw an exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address to read from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value that the component returned for this address. If the address was mapped to ram, it simply returned the value. If the address was mapped to a register the component returned the register. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1Debugger_1_1MemoryBusDebug.html#a884781dd68300d7cf32468fbe1fc1acd">ComSquare::Debugger::MemoryBusDebug</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#abd086c2053ce7432256e2b79949d46df">ComSquare::Memory::MemoryBus</a>.</p>
</div>
</div>
<a id="a474f556b1f4ef4af276217a489031775"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a474f556b1f4ef4af276217a489031775">&#9670;&nbsp;</a></span>peek_v()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t ComSquare::Memory::IMemoryBus::peek_v </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This as the same purpose as a read but it does not change the open bus and won't throw an exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address to read from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value that the component returned for this address. If the address was mapped to ram, it simply returned the value. If the address was mapped to a register the component returned the register. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>If the value address is not mapped, 0 is returned instead of nullopt. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1Debugger_1_1MemoryBusDebug.html#adbf4a8e7f30de8496a37696270aa9515">ComSquare::Debugger::MemoryBusDebug</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#ab8e47918f6eccef0aeee50cd7b77eaec">ComSquare::Memory::MemoryBus</a>.</p>
</div>
</div>
<a id="a560cf44b01d039ac4e13762e2abf46b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a560cf44b01d039ac4e13762e2abf46b1">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t ComSquare::Memory::IMemoryBus::read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data at a global address. This form allow read to be silenced. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address to read from. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classComSquare_1_1InvalidAddress.html" title="Exception thrown when trying to read/write to an invalid address.">InvalidAddress</a></td><td>If the address is not mapped to the bus, this exception is thrown. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value that the component returned for this address. If the address was mapped to ram, it simply returned the value. If the address was mapped to a register the component returned the register. </dd></dl>
<p>Implemented in <a class="el" href="classComSquare_1_1Debugger_1_1MemoryBusDebug.html#aac4caac70c61e9dca7237669490c2505">ComSquare::Debugger::MemoryBusDebug</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a8d2c99fb0e1f2dafd48180ea66fd1c7a">ComSquare::Memory::MemoryBus</a>.</p>
</div>
</div>
<a id="a393b05cf83c6dc1ee6c0cad9648cb31b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a393b05cf83c6dc1ee6c0cad9648cb31b">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ComSquare::Memory::IMemoryBus::write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a>&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a data to a global address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The address to write to. </td></tr>
<tr><td class="paramname">data</td><td>The data to write. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classComSquare_1_1Debugger_1_1MemoryBusDebug.html#a768c48fdb11d35c051b690f9c7478b2d">ComSquare::Debugger::MemoryBusDebug</a>, and <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#aa3ba7681ed7bf83fa66c8994a57dc0dd">ComSquare::Memory::MemoryBus</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sources/Memory/<a class="el" href="IMemoryBus_8hpp_source.html">IMemoryBus.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- 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