Merge pull request emu-russia#449 from ogamespec/main

Core IO Api

Breaknes/Breaknes/FormAbout.resx

@@ -18,7 +18,7 @@
     <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
     <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
     <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
-    <data name="Color1" type="System.Drawing.Color, System.Drawing"">Blue</data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
     <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
         <value>[base64 mime encoded serialized .NET Framework object]</value>
     </data>

Breaknes/BreaksCore/AbstractBoard.h

@@ -61,6 +61,11 @@ namespace Breaknes
 		Board(APUSim::Revision apu_rev, PPUSim::Revision ppu_rev, Mappers::ConnectorType p1);
 		virtual ~Board();
 
+		/// <summary>
+		/// IO Subsystem
+		/// </summary>
+		IO::IOSubsystem* io = nullptr;
+
 		/// <summary>
 		/// Simulate 1 half cycle of the board. The simulation of the signal edge is not supported, this is overkill.
 		/// </summary>

Breaknes/BreaksCore/CoreApi.cpp

@@ -263,4 +263,64 @@ extern "C"
 			board->GetAllCoreDebugInfo(info);
 		}
 	}
+
+	DLL_EXPORT size_t IOCreateInstance(uint32_t device_id)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			return board->io->CreateInstance((IO::DeviceID)device_id);
+		}
+	}
+
+	DLL_EXPORT void IOAttach(size_t port, size_t handle)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			board->io->Attach(port, handle);
+		}
+	}
+
+	DLL_EXPORT void IODetach(size_t port, size_t handle)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			board->io->Detach(port, handle);
+		}
+	}
+
+	DLL_EXPORT void IOSetState(size_t handle, size_t io_state, uint32_t value)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			board->io->SetState(handle, io_state, value);
+		}
+	}
+
+	DLL_EXPORT uint32_t IOGetState(size_t handle, size_t io_state)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			return board->io->GetState(handle, io_state);
+		}
+	}
+
+	DLL_EXPORT size_t IOGetNumStates(size_t handle)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			return board->io->GetNumStates(handle);
+		}
+	}
+
+	DLL_EXPORT void IOGetStateName(size_t handle, size_t io_state, char* name, size_t name_size)
+	{
+		if (board != nullptr && board->io != nullptr)
+		{
+			auto state_name = board->io->GetStateName(handle, io_state);
+			if (state_name.size() < name_size) {
+				strncpy(name, state_name.c_str(), name_size);
+				name[state_name.size()] = 0;
+			}
+		}
+	}
 };

Breaknes/BreaksCore/CoreApi.h

@@ -1,7 +1,5 @@
 // The top-level API for managed applications.
 
-// TBD: The API will be extended to handle I/O devices (controllers, expansion ports)
-
 #pragma once
 
 #if defined(_WINDOWS) && !defined(BREAKS_CORE_STATIC)
@@ -162,4 +160,39 @@ extern "C"
 	/// </summary>
 	/// <param name="info"></param>
 	DLL_EXPORT void GetAllCoreDebugInfo(M6502Core::DebugInfo* info);
+
+	/// <summary>
+	/// Create an IO instance of the device with the specified DeviceID. Return handle
+	/// </summary>
+	DLL_EXPORT size_t IOCreateInstance(uint32_t device_id);
+
+	/// <summary>
+	/// Connect the device to the port.
+	/// </summary>
+	DLL_EXPORT void IOAttach(size_t port, size_t handle);
+
+	/// <summary>
+	/// Disconnect the device from the port.
+	/// </summary>
+	DLL_EXPORT void IODetach(size_t port, size_t handle);
+
+	/// <summary>
+	/// Set the IOState state of the device. For example, the state of the controller buttons.
+	/// </summary>
+	DLL_EXPORT void IOSetState(size_t handle, size_t io_state, uint32_t value);
+
+	/// <summary>
+	/// Get the state of the specified device IOState.
+	/// </summary>
+	DLL_EXPORT uint32_t IOGetState(size_t handle, size_t io_state);
+
+	/// <summary>
+	/// Get the number of IO device states. For example, the number of buttons of the controller.
+	/// </summary>
+	DLL_EXPORT size_t IOGetNumStates(size_t handle);
+
+	/// <summary>
+	/// Return the IOState name of the device.
+	/// </summary>
+	DLL_EXPORT void IOGetStateName(size_t handle, size_t io_state, char* name, size_t name_size);
 };

Breaknes/BreaksCore/FamicomBoard.cpp

@@ -18,10 +18,13 @@ namespace Breaknes
 		vram = new BaseBoard::SRAM("VRAM", vram_bits);
 
 		apu->SetNormalizedOutput(true);
+
+		io = new FamicomBoardIO();
 	}
 
 	FamicomBoard::~FamicomBoard()
 	{
+		delete io;
 		delete vram;
 		delete wram;
 		delete ppu;
@@ -75,6 +78,7 @@ namespace Breaknes
 		// DMX (Bus Master)
 
 		// In real CPU in reset mode M2 goes to `Z` state, it does not suit us
+		// TODO: The pull-up is inside the DMX chip. Soon Famicom will come to disassemble, we will see what is in the chip and make LS139(DMX) properly
 		Pullup(M2);			// HACK
 
 		// The demultiplexer stages are mixed up in the Famicom. I'm not sure it makes sense to simulate it so accurately, but let it be
@@ -212,4 +216,58 @@ namespace Breaknes
 			*sample = (aux.normalized.a * 0.4f /* 20k resistor */ + aux.normalized.b /* 12k resistor */ + cart_snd.normalized /* levels pls, someone? */) / 3.0f;
 		}
 	}
+
+#pragma region "Fami IO"
+
+	FamicomBoardIO::FamicomBoardIO() : IO::IOSubsystem()
+	{
+	}
+
+	FamicomBoardIO::~FamicomBoardIO()
+	{
+	}
+
+	int FamicomBoardIO::GetPorts()
+	{
+		// Only controller ports so far
+		return 2;
+	}
+
+	void FamicomBoardIO::GetPortSupportedDevices(int port, std::list<IO::DeviceID>& devices)
+	{
+		devices.clear();
+
+		switch (port)
+		{
+			case 0:
+				devices.push_back(IO::DeviceID::FamiController_1);
+				break;
+
+			case 1:
+				devices.push_back(IO::DeviceID::FamiController_2);
+				break;
+
+			default:
+				break;
+		}
+	}
+
+	void FamicomBoardIO::sim(int port, BaseLogic::TriState inputs[], BaseLogic::TriState outputs[])
+	{
+		for (auto it = devices.begin(); it != devices.end(); ++it) {
+
+			IO::IOMapped* mapped = *it;
+
+			if (mapped->port == port && mapped->handle >= 0) {
+
+				// TODO: Assign input signals to the simulated IO device
+
+				mapped->device->sim(inputs, outputs);
+
+				// TODO: Process the output signals from the device and distribute them across the board
+			}
+		}
+	}
+
+#pragma endregion "Fami IO"
 }

Breaknes/BreaksCore/FamicomBoard.h

@@ -5,6 +5,16 @@
 
 namespace Breaknes
 {
+	class FamicomBoardIO : public IO::IOSubsystem
+	{
+	public:
+		FamicomBoardIO();
+		virtual ~FamicomBoardIO();
+		int GetPorts() override;
+		void GetPortSupportedDevices(int port, std::list<IO::DeviceID>& devices) override;
+		void sim(int port, BaseLogic::TriState inputs[], BaseLogic::TriState outputs[]) override;
+	};
+
 	class FamicomBoard : public Board
 	{
 		BaseBoard::SRAM* wram = nullptr;
@@ -55,12 +65,9 @@ namespace Breaknes
 		BaseLogic::TriState VRAM_nCE = BaseLogic::TriState::X;
 		BaseLogic::TriState PPU_nA13 = BaseLogic::TriState::X;		// To save millions of inverters inside the cartridges
 
-		// Famicom Board specific ⚠️
-		// I/O -- TBD :(
-
+		// Famicom Board specific I/O ⚠️
 		BaseBoard::LS368 P4_IO;
 		BaseBoard::LS368 P5_IO;
-
 		BaseLogic::TriState nOE1 = BaseLogic::TriState::X; 		// aka nRDP0 from cpu
 		BaseLogic::TriState nOE2 = BaseLogic::TriState::X; 		// aka nRDP1 from cpu
 		BaseLogic::TriState OUT_0 = BaseLogic::TriState::X;

Breaknes/BreaksCore/NESBoard.cpp

@@ -19,12 +19,15 @@ namespace Breaknes
 
 		apu->SetNormalizedOutput(true);
 
+		io = new NESBoardIO();
+
 		AddBoardMemDescriptors();
 		AddDebugInfoProviders();
 	}
 
 	NESBoard::~NESBoard()
 	{
+		delete io;
 		delete vram;
 		delete wram;
 		delete ppu;
@@ -80,6 +83,7 @@ namespace Breaknes
 		// DMX (Bus Master)
 
 		// In real CPU in reset mode M2 goes to `Z` state, it does not suit us
+		// TODO: The pull-up is inside the DMX chip. Soon Famicom will come to disassemble, we will see what is in the chip and make LS139(DMX) properly
 		Pullup(M2);			// HACK
 
 		DMX.sim(
@@ -229,4 +233,58 @@ namespace Breaknes
 			printf("Write PPU %d=0x%02X, phi2: %d, phi counter: 0x%llx\n", reg_sel, data_bus, apu->GetPHI2(), GetPHICounter());
 		}
 	}
+
+#pragma region "NES IO"
+
+	NESBoardIO::NESBoardIO() : IO::IOSubsystem()
+	{
+	}
+
+	NESBoardIO::~NESBoardIO()
+	{
+	}
+
+	int NESBoardIO::GetPorts()
+	{
+		// Only controller ports so far
+		return 2;
+	}
+
+	void NESBoardIO::GetPortSupportedDevices(int port, std::list<IO::DeviceID>& devices)
+	{
+		devices.clear();
+
+		switch (port)
+		{
+			case 0:
+				devices.push_back(IO::DeviceID::NESController);
+				break;
+
+			case 1:
+				devices.push_back(IO::DeviceID::NESController);
+				break;
+
+			default:
+				break;
+		}
+	}
+
+	void NESBoardIO::sim(int port, BaseLogic::TriState inputs[], BaseLogic::TriState outputs[])
+	{
+		for (auto it = devices.begin(); it != devices.end(); ++it) {
+
+			IO::IOMapped* mapped = *it;
+
+			if (mapped->port == port && mapped->handle >= 0) {
+
+				// TODO: Assign input signals to the simulated IO device
+
+				mapped->device->sim(inputs, outputs);
+
+				// TODO: Process the output signals from the device and distribute them across the board
+			}
+		}
+	}
+
+#pragma endregion "NES IO"
 }

Breaknes/BreaksCore/NESBoard.h

@@ -2,6 +2,16 @@
 
 namespace Breaknes
 {
+	class NESBoardIO : public IO::IOSubsystem
+	{
+	public:
+		NESBoardIO();
+		virtual ~NESBoardIO();
+		int GetPorts() override;
+		void GetPortSupportedDevices(int port, std::list<IO::DeviceID>& devices) override;
+		void sim(int port, BaseLogic::TriState inputs[], BaseLogic::TriState outputs[]) override;
+	};
+
 	struct NESBoardDebugInfo
 	{
 		uint32_t CLK;
@@ -60,12 +70,9 @@ namespace Breaknes
 		BaseLogic::TriState VRAM_nCE = BaseLogic::TriState::X;
 		BaseLogic::TriState PPU_nA13 = BaseLogic::TriState::X;		// To save millions of inverters inside the cartridges
 
-		// NES Board specific ⚠️
-		// I/O -- TBD :(
-
+		// NES Board specific I/O ⚠️
 		BaseBoard::LS368 P4_IO;
 		BaseBoard::LS368 P5_IO;
-
 		BaseLogic::TriState nOE1 = BaseLogic::TriState::X; 		// aka nRDP0 from cpu
 		BaseLogic::TriState nOE2 = BaseLogic::TriState::X; 		// aka nRDP1 from cpu
 		BaseLogic::TriState OUT_0 = BaseLogic::TriState::X;

Breaknes/BreaksCore/pch.h

@@ -3,6 +3,7 @@
 #include <iostream>
 #include <string>
 #include <list>
+#include <map>
 #include <cassert>
 #include <memory.h>
 #include <cstddef>
@@ -42,6 +43,10 @@
 
 #include "../../Mappers/Mappers.h"
 
+// IO Subsystem
+
+#include "../../IO/IO.h"
+
 // Boards
 
 #include "RegDumpEmitter.h"

CMakeLists.txt

@@ -103,6 +103,7 @@ add_executable (breaknes
 	IO/DendyController.cpp
 	IO/FamiController.cpp
 	IO/NESController.cpp
+	IO/UM6582.cpp
 
 	Breaknes/BreaksCore/AbstractBoard.cpp
 	Breaknes/BreaksCore/APUPlayerBoard.cpp