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

654 lines
36 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::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="#pro-attribs">Protected Attributes</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">
Inheritance diagram for ComSquare::Memory::MemoryBus:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1MemoryBus__inherit__graph.svg" width="182" 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::MemoryBus:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1Memory_1_1MemoryBus__coll__graph.svg" width="182" height="507"><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:acfefb3a3faba9f85d51d4a3827f20fad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#acfefb3a3faba9f85d51d4a3827f20fad">MemoryBus</a> ()=default</td></tr>
<tr class="memdesc:acfefb3a3faba9f85d51d4a3827f20fad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new default memory bus. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#acfefb3a3faba9f85d51d4a3827f20fad">More...</a><br /></td></tr>
<tr class="separator:acfefb3a3faba9f85d51d4a3827f20fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ac583b7900626055dded33a9ffe8e62"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a2ac583b7900626055dded33a9ffe8e62">MemoryBus</a> (const <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a> &amp;)=default</td></tr>
<tr class="memdesc:a2ac583b7900626055dded33a9ffe8e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">A memory bus is copyable. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a2ac583b7900626055dded33a9ffe8e62">More...</a><br /></td></tr>
<tr class="separator:a2ac583b7900626055dded33a9ffe8e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a407886dc529285f1708aead47b202922"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a407886dc529285f1708aead47b202922">operator=</a> (const <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a> &amp;)=default</td></tr>
<tr class="memdesc:a407886dc529285f1708aead47b202922"><td class="mdescLeft">&#160;</td><td class="mdescRight">A memory bus is assignable. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a407886dc529285f1708aead47b202922">More...</a><br /></td></tr>
<tr class="separator:a407886dc529285f1708aead47b202922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ab87359a35b85e781cbfa9a7705c21"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a08ab87359a35b85e781cbfa9a7705c21">~MemoryBus</a> () override=default</td></tr>
<tr class="memdesc:a08ab87359a35b85e781cbfa9a7705c21"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a08ab87359a35b85e781cbfa9a7705c21">More...</a><br /></td></tr>
<tr class="separator:a08ab87359a35b85e781cbfa9a7705c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d2c99fb0e1f2dafd48180ea66fd1c7a"><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#a8d2c99fb0e1f2dafd48180ea66fd1c7a">read</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) override</td></tr>
<tr class="memdesc:a8d2c99fb0e1f2dafd48180ea66fd1c7a"><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_1MemoryBus.html#a8d2c99fb0e1f2dafd48180ea66fd1c7a">More...</a><br /></td></tr>
<tr class="separator:a8d2c99fb0e1f2dafd48180ea66fd1c7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd086c2053ce7432256e2b79949d46df"><td class="memItemLeft" align="right" valign="top">std::optional&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#abd086c2053ce7432256e2b79949d46df">peek</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) override</td></tr>
<tr class="memdesc:abd086c2053ce7432256e2b79949d46df"><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_1MemoryBus.html#abd086c2053ce7432256e2b79949d46df">More...</a><br /></td></tr>
<tr class="separator:abd086c2053ce7432256e2b79949d46df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8e47918f6eccef0aeee50cd7b77eaec"><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#ab8e47918f6eccef0aeee50cd7b77eaec">peek_v</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) override</td></tr>
<tr class="memdesc:ab8e47918f6eccef0aeee50cd7b77eaec"><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_1MemoryBus.html#ab8e47918f6eccef0aeee50cd7b77eaec">More...</a><br /></td></tr>
<tr class="separator:ab8e47918f6eccef0aeee50cd7b77eaec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3ba7681ed7bf83fa66c8994a57dc0dd"><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#aa3ba7681ed7bf83fa66c8994a57dc0dd">write</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) override</td></tr>
<tr class="memdesc:aa3ba7681ed7bf83fa66c8994a57dc0dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a data to a global address. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#aa3ba7681ed7bf83fa66c8994a57dc0dd">More...</a><br /></td></tr>
<tr class="separator:aa3ba7681ed7bf83fa66c8994a57dc0dd"><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="classComSquare_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>
<tr class="memitem:acd9f28fab89e9c3b46571f049f37a0c3"><td class="memItemLeft" align="right" valign="top"><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_1MemoryBus.html#acd9f28fab89e9c3b46571f049f37a0c3">getAccessor</a> (<a class="el" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) override</td></tr>
<tr class="memdesc:acd9f28fab89e9c3b46571f049f37a0c3"><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#acd9f28fab89e9c3b46571f049f37a0c3">More...</a><br /></td></tr>
<tr class="separator:acd9f28fab89e9c3b46571f049f37a0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classComSquare_1_1Memory_1_1IMemoryBus"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classComSquare_1_1Memory_1_1IMemoryBus')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html">ComSquare::Memory::IMemoryBus</a></td></tr>
<tr class="memitem:a5538f7e281f45053245a4036473a5e46 inherit pub_methods_classComSquare_1_1Memory_1_1IMemoryBus"><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 inherit pub_methods_classComSquare_1_1Memory_1_1IMemoryBus"><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 inherit pub_methods_classComSquare_1_1Memory_1_1IMemoryBus"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a44706b738a5156bc5764c6f91b02b2d1"><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#a44706b738a5156bc5764c6f91b02b2d1">_openBus</a> = 0</td></tr>
<tr class="memdesc:a44706b738a5156bc5764c6f91b02b2d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last value read via the memory bus. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a44706b738a5156bc5764c6f91b02b2d1">More...</a><br /></td></tr>
<tr class="separator:a44706b738a5156bc5764c6f91b02b2d1"><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:a16c3072d4f993d6a71f31d08e9443d7d"><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#a16c3072d4f993d6a71f31d08e9443d7d">_mirrorComponents</a> (<a class="el" href="classComSquare_1_1SNES.html">SNES</a> &amp;console, unsigned i)</td></tr>
<tr class="memdesc:a16c3072d4f993d6a71f31d08e9443d7d"><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; <a class="el" href="namespaceComSquare_1_1APU.html">APU</a> 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#a16c3072d4f993d6a71f31d08e9443d7d">More...</a><br /></td></tr>
<tr class="separator:a16c3072d4f993d6a71f31d08e9443d7d"><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:a459e00b9af02fc957801e96a075cd043"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::reference_wrapper&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#a459e00b9af02fc957801e96a075cd043">_memoryAccessors</a></td></tr>
<tr class="memdesc:a459e00b9af02fc957801e96a075cd043"><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#a459e00b9af02fc957801e96a075cd043">More...</a><br /></td></tr>
<tr class="separator:a459e00b9af02fc957801e96a075cd043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a448900a4e9599e6e4b1180eecf559edf"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a448900a4e9599e6e4b1180eecf559edf">_shadows</a> = {}</td></tr>
<tr class="memdesc:a448900a4e9599e6e4b1180eecf559edf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of simple memory shadows that are used to map duplicated zones of memory. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a448900a4e9599e6e4b1180eecf559edf">More...</a><br /></td></tr>
<tr class="separator:a448900a4e9599e6e4b1180eecf559edf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a145fa3ec52b03c05ea8cbd37434cf987"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html#a145fa3ec52b03c05ea8cbd37434cf987">_rectangleShadows</a> = {}</td></tr>
<tr class="memdesc:a145fa3ec52b03c05ea8cbd37434cf987"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of rectangle memory shadows that are used to map duplicated zones of memory. <a href="classComSquare_1_1Memory_1_1MemoryBus.html#a145fa3ec52b03c05ea8cbd37434cf987">More...</a><br /></td></tr>
<tr class="separator:a145fa3ec52b03c05ea8cbd37434cf987"><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="acfefb3a3faba9f85d51d4a3827f20fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfefb3a3faba9f85d51d4a3827f20fad">&#9670;&nbsp;</a></span>MemoryBus() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::Memory::MemoryBus::MemoryBus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new default memory bus. </p>
</div>
</div>
<a id="a2ac583b7900626055dded33a9ffe8e62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac583b7900626055dded33a9ffe8e62">&#9670;&nbsp;</a></span>MemoryBus() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::Memory::MemoryBus::MemoryBus </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A memory bus is copyable. </p>
</div>
</div>
<a id="a08ab87359a35b85e781cbfa9a7705c21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ab87359a35b85e781cbfa9a7705c21">&#9670;&nbsp;</a></span>~MemoryBus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::Memory::MemoryBus::~MemoryBus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a16c3072d4f993d6a71f31d08e9443d7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16c3072d4f993d6a71f31d08e9443d7d">&#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="classComSquare_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">unsigned&#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">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; <a class="el" href="namespaceComSquare_1_1APU.html">APU</a> 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="acd9f28fab89e9c3b46571f049f37a0c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd9f28fab89e9c3b46571f049f37a0c3">&#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"><a class="el" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> * 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">override</span><span class="mlabel">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>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#ad0ab5473f22b232b701a7fc101f4489b">ComSquare::Memory::IMemoryBus</a>.</p>
</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="classComSquare_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="a407886dc529285f1708aead47b202922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a407886dc529285f1708aead47b202922">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a>&amp; ComSquare::Memory::MemoryBus::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1Memory_1_1MemoryBus.html">MemoryBus</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A memory bus is assignable. </p>
</div>
</div>
<a id="abd086c2053ce7432256e2b79949d46df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd086c2053ce7432256e2b79949d46df">&#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">std::optional&lt; uint8_t &gt; ComSquare::Memory::MemoryBus::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">override</span><span class="mlabel">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>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a715161996b7842c55c0be82d3cd22572">ComSquare::Memory::IMemoryBus</a>.</p>
</div>
</div>
<a id="ab8e47918f6eccef0aeee50cd7b77eaec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8e47918f6eccef0aeee50cd7b77eaec">&#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">uint8_t ComSquare::Memory::MemoryBus::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">override</span><span class="mlabel">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>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a474f556b1f4ef4af276217a489031775">ComSquare::Memory::IMemoryBus</a>.</p>
</div>
</div>
<a id="a8d2c99fb0e1f2dafd48180ea66fd1c7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d2c99fb0e1f2dafd48180ea66fd1c7a">&#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">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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a560cf44b01d039ac4e13762e2abf46b1">ComSquare::Memory::IMemoryBus</a>.</p>
</div>
</div>
<a id="aa3ba7681ed7bf83fa66c8994a57dc0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3ba7681ed7bf83fa66c8994a57dc0dd">&#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">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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classComSquare_1_1Memory_1_1IMemoryBus.html#a393b05cf83c6dc1ee6c0cad9648cb31b">ComSquare::Memory::IMemoryBus</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a459e00b9af02fc957801e96a075cd043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a459e00b9af02fc957801e96a075cd043">&#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::reference_wrapper&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="a44706b738a5156bc5764c6f91b02b2d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44706b738a5156bc5764c6f91b02b2d1">&#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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last value read via the memory bus. </p>
</div>
</div>
<a id="a145fa3ec52b03c05ea8cbd37434cf987"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a145fa3ec52b03c05ea8cbd37434cf987">&#9670;&nbsp;</a></span>_rectangleShadows</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;<a class="el" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a>&gt; ComSquare::Memory::MemoryBus::_rectangleShadows = {}</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 rectangle memory shadows that are used to map duplicated zones of memory. </p>
</div>
</div>
<a id="a448900a4e9599e6e4b1180eecf559edf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a448900a4e9599e6e4b1180eecf559edf">&#9670;&nbsp;</a></span>_shadows</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;<a class="el" href="classComSquare_1_1Memory_1_1MemoryShadow.html">MemoryShadow</a>&gt; ComSquare::Memory::MemoryBus::_shadows = {}</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 simple memory shadows that are used to map duplicated zones of memory. </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