/*
AppleWin : An Apple //e emulator for Windows

Copyright (C) 1994-1996, Michael O'Brien
Copyright (C) 1999-2001, Oliver Schmidt
Copyright (C) 2002-2005, Tom Charlesworth
Copyright (C) 2006-2010, Tom Charlesworth, Michael Pohoreski, Nick Westgate

AppleWin is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

AppleWin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with AppleWin; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/* Description: No Slot Clock/Phantom Clock (Dallas SmartWatch DS1216) emulation
 *
 * Author: Nick Westgate
 */

#pragma once

class CNoSlotClock
{
	class RingRegister64
	{
	public:
		RingRegister64();
		RingRegister64(UINT64 data);

		void Reset();
		void WriteNibble(int data);
		void WriteBits(int data, int count);
		void WriteBit(int data);
		void ReadBit(BYTE& data);
		bool CompareBit(int data);
		bool NextBit();

		UINT64 m_Mask;
		UINT64 m_Register;
	};

public:
	CNoSlotClock();

	void Reset();
	bool ReadWrite(int address, BYTE& data, BYTE write);
	bool ClockRead(BYTE& data);
	void ClockWrite(int address);

	void SaveSnapshot(class YamlSaveHelper& yamlSaveHelper);
	void LoadSnapshot(class YamlLoadHelper& yamlLoadHelper);

	bool m_bClockRegisterEnabled;
	bool m_bWriteEnabled;
	RingRegister64 m_ClockRegister;
	RingRegister64 m_ComparisonRegister;

private:
	bool Read(int address, BYTE& data);
	void Write(int address);
	void PopulateClockRegister();
	const std::string& GetSnapshotStructName(void);

	static const UINT64 kClockInitSequence = 0x5CA33AC55CA33AC5;
};