From 5fde3b8d5d04a33958664e5e221b9e9d5eb41c7d Mon Sep 17 00:00:00 2001
From: Thomas Harte <thomas.harte@gmail.com>
Date: Wed, 6 Dec 2023 22:56:09 -0500
Subject: [PATCH] Wire up a stub RTC plus appropriate option ROM.

---
 Machines/PCCompatible/PCCompatible.cpp        |  24 ++++++++---
 Machines/PCCompatible/RTC.hpp                 |  40 ++++++++++++++++++
 Machines/Utility/ROMCatalogue.cpp             |   3 ++
 Machines/Utility/ROMCatalogue.hpp             |   1 +
 .../Clock Signal.xcodeproj/project.pbxproj    |   2 +
 ROMImages/PCCompatible/GLaTICK_0.8.5_AT.ROM   | Bin 0 -> 2048 bytes
 ROMImages/PCCompatible/readme.txt             |   7 ++-
 7 files changed, 69 insertions(+), 8 deletions(-)
 create mode 100644 Machines/PCCompatible/RTC.hpp
 create mode 100644 ROMImages/PCCompatible/GLaTICK_0.8.5_AT.ROM

diff --git a/Machines/PCCompatible/PCCompatible.cpp b/Machines/PCCompatible/PCCompatible.cpp
index a0e57a8dd..ddb015126 100644
--- a/Machines/PCCompatible/PCCompatible.cpp
+++ b/Machines/PCCompatible/PCCompatible.cpp
@@ -15,6 +15,7 @@
 #include "Memory.hpp"
 #include "PIC.hpp"
 #include "PIT.hpp"
+#include "RTC.hpp"
 
 #include "../../InstructionSets/x86/Decoder.hpp"
 #include "../../InstructionSets/x86/Flags.hpp"
@@ -601,8 +602,8 @@ using PPI = Intel::i8255::i8255<i8255PortHandler>;
 template <VideoAdaptor video>
 class IO {
 	public:
-		IO(PIT &pit, DMA &dma, PPI &ppi, PIC &pic, typename Adaptor<video>::type &card, FloppyController &fdc) :
-			pit_(pit), dma_(dma), ppi_(ppi), pic_(pic), video_(card), fdc_(fdc) {}
+		IO(PIT &pit, DMA &dma, PPI &ppi, PIC &pic, typename Adaptor<video>::type &card, FloppyController &fdc, RTC &rtc) :
+			pit_(pit), dma_(dma), ppi_(ppi), pic_(pic), video_(card), fdc_(fdc), rtc_(rtc) {}
 
 		template <typename IntT> void out(uint16_t port, IntT value) {
 			static constexpr uint16_t crtc_base =
@@ -617,6 +618,9 @@ class IO {
 					}
 				break;
 
+				case 0x0070:	rtc_.write<0>(uint8_t(value));	break;
+				case 0x0071:	rtc_.write<1>(uint8_t(value));	break;
+
 				// On the XT the NMI can be masked by setting bit 7 on I/O port 0xA0.
 				case 0x00a0:
 					printf("TODO: NMIs %s\n", (value & 0x80) ? "masked" : "unmasked");
@@ -751,6 +755,8 @@ class IO {
 				case 0x006c:	case 0x006d:	case 0x006e:	case 0x006f:
 				return ppi_.read(port);
 
+				case 0x0071:	return rtc_.read();
+
 				case 0x0080:	return dma_.pages.page<0>();
 				case 0x0081:	return dma_.pages.page<1>();
 				case 0x0082:	return dma_.pages.page<2>();
@@ -804,6 +810,7 @@ class IO {
 		PIC &pic_;
 		typename Adaptor<video>::type &video_;
 		FloppyController &fdc_;
+		RTC &rtc_;
 };
 
 class FlowController {
@@ -880,7 +887,7 @@ class ConcreteMachine:
 			ppi_handler_(speaker_, keyboard_, video, DriveCount),
 			pit_(pit_observer_),
 			ppi_(ppi_handler_),
-			context(pit_, dma_, ppi_, pic_, video_, fdc_)
+			context(pit_, dma_, ppi_, pic_, video_, fdc_, rtc_)
 		{
 			// Set up DMA source/target.
 			dma_.set_memory(&context.memory);
@@ -892,9 +899,10 @@ class ConcreteMachine:
 
 			// Fetch the BIOS. [8088 only, for now]
 			const auto bios = ROM::Name::PCCompatibleGLaBIOS;
+			const auto tick = ROM::Name::PCCompatibleGLaTICK;
 			const auto font = Video::FontROM;
 
-			ROM::Request request = ROM::Request(bios) && ROM::Request(font);
+			ROM::Request request = ROM::Request(bios) && ROM::Request(tick) && ROM::Request(font);
 			auto roms = rom_fetcher(request);
 			if(!request.validate(roms)) {
 				throw ROMMachine::Error::MissingROMs;
@@ -903,6 +911,9 @@ class ConcreteMachine:
 			const auto &bios_contents = roms.find(bios)->second;
 			context.memory.install(0x10'0000 - bios_contents.size(), bios_contents.data(), bios_contents.size());
 
+			const auto &tick_contents = roms.find(tick)->second;
+			context.memory.install(0xd'0000, tick_contents.data(), tick_contents.size());
+
 			// Give the video card something to read from.
 			const auto &font_contents = roms.find(font)->second;
 			video_.set_source(context.memory.at(Video::BaseAddress), font_contents);
@@ -1095,15 +1106,16 @@ class ConcreteMachine:
 
 		PIT pit_;
 		PPI ppi_;
+		RTC rtc_;
 
 		PCCompatible::KeyboardMapper keyboard_mapper_;
 
 		struct Context {
-			Context(PIT &pit, DMA &dma, PPI &ppi, PIC &pic, typename Adaptor<video>::type &card, FloppyController &fdc) :
+			Context(PIT &pit, DMA &dma, PPI &ppi, PIC &pic, typename Adaptor<video>::type &card, FloppyController &fdc, RTC &rtc) :
 				segments(registers),
 				memory(registers, segments),
 				flow_controller(registers, segments),
-				io(pit, dma, ppi, pic, card, fdc)
+				io(pit, dma, ppi, pic, card, fdc, rtc)
 			{
 				reset();
 			}
diff --git a/Machines/PCCompatible/RTC.hpp b/Machines/PCCompatible/RTC.hpp
new file mode 100644
index 000000000..f8dcee957
--- /dev/null
+++ b/Machines/PCCompatible/RTC.hpp
@@ -0,0 +1,40 @@
+//
+//  RTC.hpp
+//  Clock Signal
+//
+//  Created by Thomas Harte on 06/12/2023.
+//  Copyright © 2023 Thomas Harte. All rights reserved.
+//
+
+#ifndef RTC_h
+#define RTC_h
+
+namespace PCCompatible {
+
+class RTC {
+	public:
+		template <int address>
+		void write(uint8_t value) {
+			switch(address) {
+				default: break;
+				case 0:
+					selected_ = value & 0x7f;
+					// NMI not yet supported.
+				break;
+				case 1:
+					// TODO.
+				break;
+			}
+		}
+
+		uint8_t read() {
+			return 0x00;
+		}
+
+	private:
+		int selected_;
+};
+
+}
+
+#endif /* RTC_h */
diff --git a/Machines/Utility/ROMCatalogue.cpp b/Machines/Utility/ROMCatalogue.cpp
index 6536cd5e9..9720ffa75 100644
--- a/Machines/Utility/ROMCatalogue.cpp
+++ b/Machines/Utility/ROMCatalogue.cpp
@@ -570,6 +570,9 @@ Description::Description(Name name) {
 		case Name::PCCompatibleGLaBIOS:
 			*this = Description(name, "PCCompatible", "8088 GLaBIOS 0.2.5", "GLABIOS_0.2.5_8T.ROM", 8 * 1024, 0x9576944cu);
 		break;
+		case Name::PCCompatibleGLaTICK:
+			*this = Description(name, "PCCompatible", "AT GLaTICK 0.8.5", "GLaTICK_0.8.5_AT.ROM", 2 * 1024, 0x371ea3f1u);
+		break;
 		case Name::PCCompatiblePhoenix80286BIOS:
 			*this = Description(name, "PCCompatible", "Phoenix 80286 BIOS 3.05", "Phoenix 80286 ROM BIOS Version 3.05.bin", 32 * 1024, 0x8d0d318au);
 		break;
diff --git a/Machines/Utility/ROMCatalogue.hpp b/Machines/Utility/ROMCatalogue.hpp
index b0603e830..3a15692ee 100644
--- a/Machines/Utility/ROMCatalogue.hpp
+++ b/Machines/Utility/ROMCatalogue.hpp
@@ -134,6 +134,7 @@ enum Name {
 
 	// PCCompatible.
 	PCCompatibleGLaBIOS,
+	PCCompatibleGLaTICK,
 	PCCompatiblePhoenix80286BIOS,
 	PCCompatibleMDAFont,
 	PCCompatibleCGAFont,
diff --git a/OSBindings/Mac/Clock Signal.xcodeproj/project.pbxproj b/OSBindings/Mac/Clock Signal.xcodeproj/project.pbxproj
index 173d32e10..812890027 100644
--- a/OSBindings/Mac/Clock Signal.xcodeproj/project.pbxproj	
+++ b/OSBindings/Mac/Clock Signal.xcodeproj/project.pbxproj	
@@ -1194,6 +1194,7 @@
 		42AD55302A0C4D5000ACE410 /* 68000Storage.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = 68000Storage.hpp; sourceTree = "<group>"; };
 		42AD55312A0C4D5000ACE410 /* 68000Implementation.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = 68000Implementation.hpp; sourceTree = "<group>"; };
 		42E5C3922AC46A7700DA093D /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
+		42EB81252B21788200429AF4 /* RTC.hpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.h; path = RTC.hpp; sourceTree = "<group>"; };
 		4B018B88211930DE002A3937 /* 65C02_extended_opcodes_test.bin */ = {isa = PBXFileReference; lastKnownFileType = archive.macbinary; name = 65C02_extended_opcodes_test.bin; path = "Klaus Dormann/65C02_extended_opcodes_test.bin"; sourceTree = "<group>"; };
 		4B01A6871F22F0DB001FD6E3 /* Z80MemptrTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Z80MemptrTests.swift; sourceTree = "<group>"; };
 		4B0333AD2094081A0050B93D /* AppleDSK.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = AppleDSK.cpp; sourceTree = "<group>"; };
@@ -2405,6 +2406,7 @@
 				4267A9C82B0D4EC2008A59BB /* PIC.hpp */,
 				4267A9C72B0C26FA008A59BB /* PIT.hpp */,
 				423820142B1A23C200964EFE /* Registers.hpp */,
+				42EB81252B21788200429AF4 /* RTC.hpp */,
 				423820152B1A23E100964EFE /* Segments.hpp */,
 			);
 			path = PCCompatible;
diff --git a/ROMImages/PCCompatible/GLaTICK_0.8.5_AT.ROM b/ROMImages/PCCompatible/GLaTICK_0.8.5_AT.ROM
new file mode 100644
index 0000000000000000000000000000000000000000..5d767b240edf29ff8d74f41c06b110ff02c22a25
GIT binary patch
literal 2048
zcmeHF@lO+H7=G`&(!wFo5SI-?>}{#2TgFV$#hKy|vLKO|(jr1TVK{2QDJ<6(vt-%o
zz?$6|5@{A?0nOr;EDI)w)~v`@!7FHRok+&)HkT9!<HZ_6vH_#wZeQgu*zew(T;BKj
zp68x?&%OJ<(ezk01dE|F+P+H$@RVDt4`{KDxV527f|)EH*MwZetqZk~LN#u*;x(ub
zXd=0S5ic=<AwX!GgQpl_J?1e1CX#!Z!938_*Vzp<y|)7?1Kyl#421)1w=@>X?T$~`
zss}S6R7bFa)H$%5oK)S7(#?)(cM7JFIE(27-6TmlM9@MyCfxd`CY-f0>FeTZ?V%=u
z4J2N02BVDpD$X<FC{8B3X-2$(w;7qoUzu9FID*$1c_;qJh{Jf5nR||GsO(AfYbIh{
z8`UiC!9^JghdQHSZ4+FqVoqzTnNN2$!RgE+&|7Oz)<XG02I-#@vuc(YHZB;H$o@Mv
zDT;dVi(%y8+s36?lgcU%1zDKn6frjbXswJ{%1@jzYkYdGxUk|I!CzG0h;JAtRNt^~
z6mP4((F5YorX?vMo0n$9d3LzpygbF;Y@dL;5AQ~M&IW_c%d@>MZOZ*^?GxG3SkMT|
zv+ON;e(G+$;(fw?$P`~`T>8rw?ilhAU)abh^v*8Toa55dD<4tKW|xj;(?FX=MH<Eu
zwdgyY@IsLx^>{YL%hf&Rb*@yJ*_*U8EGijXSw%xtdFfu>!5-wx-J4we?nA8}H(%9!
z%$dPeJB6M6)`A@c+xg9<TX@q}Qz8HQwyk?hc&qcMv%%$T<UK8oPJu78RJ0XlaA2(}
zh0>#~@4g3b2|}v?`&wI^u)B%}x^l4489lKJVqBS_M%izX9$oNGGv33g|E3;JtvPtd
zLIY-?#xjm;l^l#&W-hP!HH)qAw?Jk@@2F9D2M_!~z#__&wKnmOfixIo0nLC8s198x
z_y&mg_w}!@#4S);M-`SpRzz=RKKg+!$qtb7<723WYTOKUN=P9CBq_H9`Lu|>X3eLd
zuVcuqiRj~hQ#C$RLk<$3vDhlD7LyuaDNP)w`>D6r(&P7`m<*A}-c_b8#k-o)#?D2a
z9I*NE@{<*JhNSpn<FRx80`=?%tfPL8Q%|yk>;h}h_z{>DPkurMjDo<6F`3{U5S|xr
z$r>C5AyY&-9lr-5#mIE|mBI;WY$d+z$1zy(EF`cKWDx(vK9Gqxg<pZJ5oho`P>Bc|
z-+^^x{9$&CP7?SPKYm6<)G8H^fpC>t>97%mzAo8>Z-ek91=7$4=Fb;}b7zwD!<4?9
zz?VVRi4SlO6jP@X`kta0%O+~HJ!$kJ7(b@cblgNef?PftAejCM=0Gt`SI(e6Pq9k(
z=Hn2Dl1FCyqW$UU3qJ+sePO%OQ#pX_W0_0fr24ftwithfA}oaVv8#!KOWkMjch!@T
o{PKv3S5$MpbR&iyoy<u0u2-?O7kbYt@a%b(z_SGYR{}5n2PSGg9{>OV

literal 0
HcmV?d00001

diff --git a/ROMImages/PCCompatible/readme.txt b/ROMImages/PCCompatible/readme.txt
index faf0be717..d15254705 100644
--- a/ROMImages/PCCompatible/readme.txt
+++ b/ROMImages/PCCompatible/readme.txt
@@ -1,11 +1,14 @@
 Expected files:
 
-GLABIOS_0.2.5_8T.ROM — the 8088 GlaBIOS ROM.
+GLABIOS_0.2.5_8T.ROM — the 8088 GLaBIOS ROM.
+GLaTICK_0.8.5_AT.ROM — the GLaBIOS AT RTC option ROM.
 Phoenix 80286 ROM BIOS Version 3.05.bin — Phoenix's 80286 AT-clone BIOS.
 EUMDA9.F14 — a dump of the MDA font.
 CGA.F08 — a dump of the CGA font.
 
 
-GlaBIOS is an open-source GPLv3 alternative BIOS for XT clones, available from https://glabios.org/
+GLaBIOS is an open-source GPLv3 alternative BIOS for XT clones, available from https://glabios.org/
+
+GLaTICK is a real-time clock option ROM, also available from available from https://glabios.org/
 
 The MDA and CGA fonts are in the form offered at https://github.com/viler-int10h/vga-text-mode-fonts i.e. it's 256 lots of 14 bytes, the first 14 being the content of character 0, the next 14 being the content of character 1, etc.
\ No newline at end of file