zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2025-12-20 14:15:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bc65afb405e2c5e8be8982f6843d3731e95d5d25
ComSquare/docs/classComSquare_1_1Memory_1_1MemoryBus.html
Melefo bc65afb405 Starting testing
2020-02-05 16:15:21 +01:00

356 lines
19 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: ComSquare::Memory::MemoryBus 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_1MemoryBus.html">MemoryBus</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classComSquare_1_1Memory_1_1MemoryBus-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::Memory::MemoryBus Class Reference</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_1MemoryBus.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MemoryBus_8hpp_source.html">MemoryBus.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ComSquare::Memory::MemoryBus:</div>
<div class="dyncontent">
<div class="center"><img src="classComSquare_1_1Memory_1_1MemoryBus__coll__graph.png" border="0" usemap="#ComSquare_1_1Memory_1_1MemoryBus_coll__map" alt="Collaboration graph"/></div>
<map name="ComSquare_1_1Memory_1_1MemoryBus_coll__map" id="ComSquare_1_1Memory_1_1MemoryBus_coll__map">
<area shape="rect" title="The memory bus is the component responsible of mapping addresses to components address and transmitti..." alt="" coords="5,5,176,171"/>
</map>
</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:a66fe80e0dafb6078eabf809b2ecd6dae"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a66fe80e0dafb6078eabf809b2ecd6dae">read</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)</td></tr>
<tr class="memdesc:a66fe80e0dafb6078eabf809b2ecd6dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data at a global address. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a66fe80e0dafb6078eabf809b2ecd6dae">More...</a><br /></td></tr>
<tr class="separator:a66fe80e0dafb6078eabf809b2ecd6dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1387b77513d9e0d077291477faab46cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a1387b77513d9e0d077291477faab46cd">write</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data)</td></tr>
<tr class="memdesc:a1387b77513d9e0d077291477faab46cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a data to a global address. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a1387b77513d9e0d077291477faab46cd">More...</a><br /></td></tr>
<tr class="separator:a1387b77513d9e0d077291477faab46cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21e37ae17ad577a34af5ba49fbdf7180"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a21e37ae17ad577a34af5ba49fbdf7180">mapComponents</a> (<a class="el" href="structComSquare_1_1SNES.html">SNES</a> &amp;console)</td></tr>
<tr class="memdesc:a21e37ae17ad577a34af5ba49fbdf7180"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map components to the address space using the currently loaded cartridge to set the right mapping mode. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a21e37ae17ad577a34af5ba49fbdf7180">More...</a><br /></td></tr>
<tr class="separator:a21e37ae17ad577a34af5ba49fbdf7180"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a1b7ba0ca63589d971404e1b7031f26c1"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a1b7ba0ca63589d971404e1b7031f26c1">getAccessor</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr)</td></tr>
<tr class="memdesc:a1b7ba0ca63589d971404e1b7031f26c1"><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_1MemoryBus.html#a1b7ba0ca63589d971404e1b7031f26c1">More...</a><br /></td></tr>
<tr class="separator:a1b7ba0ca63589d971404e1b7031f26c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa5f49e6918eb466bc9116f042c7c636"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#afa5f49e6918eb466bc9116f042c7c636">_mirrorComponents</a> (<a class="el" href="structComSquare_1_1SNES.html">SNES</a> &amp;console, <a class="el" href="CMakeCache_8txt.html#a79a3d8790b2588b09777910863574e09">int</a> i)</td></tr>
<tr class="memdesc:afa5f49e6918eb466bc9116f042c7c636"><td class="mdescLeft">&#160;</td><td class="mdescRight">WRam, <a class="el" href="namespaceComSquare_1_1CPU.html">CPU</a>, <a class="el" href="namespaceComSquare_1_1PPU.html">PPU</a> &amp; ALU registers are mirrored to all banks of Q1 &amp; Q3. This function is used for the mirroring. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#afa5f49e6918eb466bc9116f042c7c636">More...</a><br /></td></tr>
<tr class="separator:afa5f49e6918eb466bc9116f042c7c636"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2c2385dddba2ec8f143f2d88a58a9431"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::shared_ptr&lt; <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a2c2385dddba2ec8f143f2d88a58a9431">_memoryAccessors</a></td></tr>
<tr class="memdesc:a2c2385dddba2ec8f143f2d88a58a9431"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of components registered inside the bus. Every components that can read/write to a public address should be in this vector. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a2c2385dddba2ec8f143f2d88a58a9431">More...</a><br /></td></tr>
<tr class="separator:a2c2385dddba2ec8f143f2d88a58a9431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab55064b581ef9348bc47e0f277a0439d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#ab55064b581ef9348bc47e0f277a0439d">_openBus</a> = 0</td></tr>
<tr class="memdesc:ab55064b581ef9348bc47e0f277a0439d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last value read via the memory bus. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#ab55064b581ef9348bc47e0f277a0439d">More...</a><br /></td></tr>
<tr class="separator:ab55064b581ef9348bc47e0f277a0439d"><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">Member Function Documentation</h2>
<a id="afa5f49e6918eb466bc9116f042c7c636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa5f49e6918eb466bc9116f042c7c636">&#9670;&nbsp;</a></span>_mirrorComponents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ComSquare::Memory::MemoryBus::_mirrorComponents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structComSquare_1_1SNES.html">SNES</a> &amp;&#160;</td>
<td class="paramname"><em>console</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="CMakeCache_8txt.html#a79a3d8790b2588b09777910863574e09">int</a>&#160;</td>
<td class="paramname"><em>i</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">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>WRam, <a class="el" href="namespaceComSquare_1_1CPU.html">CPU</a>, <a class="el" href="namespaceComSquare_1_1PPU.html">PPU</a> &amp; ALU registers are mirrored to all banks of Q1 &amp; Q3. This function is used for the mirroring. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">console</td><td>All the components. </td></tr>
<tr><td class="paramname">i</td><td>Base address for the mirrors. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1b7ba0ca63589d971404e1b7031f26c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b7ba0ca63589d971404e1b7031f26c1">&#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">std::shared_ptr&lt; <a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &gt; ComSquare::Memory::MemoryBus::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">private</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>
</div>
</div>
<a id="a21e37ae17ad577a34af5ba49fbdf7180"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21e37ae17ad577a34af5ba49fbdf7180">&#9670;&nbsp;</a></span>mapComponents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::Memory::MemoryBus::mapComponents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structComSquare_1_1SNES.html">SNES</a> &amp;&#160;</td>
<td class="paramname"><em>console</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Map components to the address space using the currently loaded cartridge to set the right mapping mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">console</td><td>All the components. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a66fe80e0dafb6078eabf809b2ecd6dae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66fe80e0dafb6078eabf809b2ecd6dae">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::Memory::MemoryBus::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>
</div><div class="memdoc">
<p>Read data at a global address. </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>
</div>
</div>
<a id="a1387b77513d9e0d077291477faab46cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1387b77513d9e0d077291477faab46cd">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::Memory::MemoryBus::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>
</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>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2c2385dddba2ec8f143f2d88a58a9431"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c2385dddba2ec8f143f2d88a58a9431">&#9670;&nbsp;</a></span>_memoryAccessors</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::shared_ptr&lt;<a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a>&gt; &gt; ComSquare::Memory::MemoryBus::_memoryAccessors</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The list of components registered inside the bus. Every components that can read/write to a public address should be in this vector. </p>
</div>
</div>
<a id="ab55064b581ef9348bc47e0f277a0439d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab55064b581ef9348bc47e0f277a0439d">&#9670;&nbsp;</a></span>_openBus</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::Memory::MemoryBus::_openBus = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last value read via the memory bus. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Memory/<a class="el" href="MemoryBus_8hpp_source.html">MemoryBus.hpp</a></li>
<li>sources/Memory/<a class="el" href="MemoryBus_8cpp.html">MemoryBus.cpp</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