/* -*- mode: C++; tab-width: 4 -*- */
/* ===================================================================== *\
	Copyright (c) 1999-2001 Palm, Inc. or its subsidiaries.
	All rights reserved.

	This file is part of the Palm OS Emulator.

	This program 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.
\* ===================================================================== */

#include "EmCommon.h"
#include "EmDevice.h"

/*
	This file controls the creation of a new device in the Palm OS
	Emulator.  In order to add a new device to the set of supported
	devices:

	* Add a new kDeviceFoo value to DeviceType.

	* Add information about the new device to the kDeviceInfo array.

	* Define and add a sub-class of EmRegs to describe the hardware
	  registers for the device (e.g., EmRegsEZPalmV).  This sub-class
	  can be a typedef of another sub-class if the hardware is the
	  same (e.g., EmRegsEZPalmVx).

	* Define and add any other EmRegs sub-classes as needed if the
	  device has any special hardware needs (e.g., EmRegsUSBVisor).

	* Add a new "case" statement in CreateRegs that creates the
	  appropriate EmRegs sub-classes.

	* If your needs are extensive and creating a sub-class of EmRegs
	  isn't sufficient, then consider creating a new EmBankFoo and
	  managing that in EmMemory.cpp along with all the other EmBankFoos.

	* Modify SupportsROM to make sure that your device appears on the
	  device list when your ROM is selected, and try to make sure that
	  it does not appear for other ROMs.  If ROMs for this device can
	  be identified via companyID and halID fields in the card header,
	  then you don't need to do anything here.
*/

#include "Platform.h"			// _stricmp

#include "EmBankRegs.h"			// AddSubBank
#include "EmROMReader.h"		// EmROMReader
#include "EmStreamFile.h"		// EmStreamFile
#include "Miscellaneous.h"		// StMemory

#include "PalmPack.h"
#define NON_PORTABLE
	#include "HwrMiscFlags.h"		// hwrMiscFlagIDTouchdown, etc.

	#ifndef hwrMiscFlagIDPalmIIIc
	#define	hwrMiscFlagIDPalmIIIc			(hwrMiscFlagID4 | hwrMiscFlagID1)
	#endif

	// The m100 ID has changed
	#undef hwrMiscFlagIDm100
	#define hwrMiscFlagIDm100	(hwrMiscFlagID3 | hwrMiscFlagID1)

#undef NON_PORTABLE
#include "PalmPackPop.h"

#include "EmCPU68K.h"
#include "EmCPUARM.h"

#include "EmRegs328Pilot.h"
#include "EmRegs328PalmPilot.h"
#include "EmRegs328PalmIII.h"
#include "EmRegs328PalmVII.h"
#include "EmRegs328Symbol1700.h"

#include "EmRegsEZPalmIIIc.h"
#include "EmRegsEZPalmIIIe.h"
#include "EmRegsEZPalmIIIx.h"
#include "EmRegsEZPalmV.h"
#include "EmRegsEZPalmVx.h"
#include "EmRegsEZPalmVII.h"
#include "EmRegsEZPalmVIIx.h"
#include "EmRegsEZPalmM100.h"
#include "EmRegsEZVisor.h"
#include "EmRegsEZTemp.h"

#include "EmRegsSZTemp.h"

#include "EmRegsVZPalmM500.h"
#include "EmRegsVZPalmM505.h"
#include "EmRegsVZVisorPrism.h"
#include "EmRegsVZVisorPlatinum.h"
#include "EmRegsVZVisorEdge.h"
#include "EmRegsVZTemp.h"

#include "EmRegsASICSymbol1700.h"
#include "EmRegsFrameBuffer.h"
#include "EmRegsPLDPalmVIIEZ.h"
#include "EmRegsSED1375.h"
#include "EmRegsSED1376.h"
#include "EmRegsUSBPhilipsPDIUSBD12.h"
#include "EmRegsUSBVisor.h"

#include "EmTRG.h"

#include "EmRegsMediaQ11xx.h"


enum	// DeviceType
{
	kDeviceUnspecified	= 0,
	kDevicePilot,
	kDevicePalmPilot,
	kDevicePalmIII,
	kDevicePalmIIIc,
	kDevicePalmIIIe,
	kDevicePalmIIIx,
	kDevicePalmV,
	kDevicePalmVx,
	kDevicePalmVII,
	kDevicePalmVIIEZ,
	kDevicePalmVIIx,
	kDevicePalmM100,
	kDevicePalmM125,
	kDevicePalmM130,
	kDevicePalmM500,
	kDevicePalmM505,
	kDevicePalmM515,
	kDevicePalmI705,
	kDeviceARMRef,
	kDeviceSymbol1500,
	kDeviceSymbol1700,
	kDeviceSymbol1740,
	kDeviceTRGpro,
	kDeviceHandEra330,
	kDeviceVisor,
	kDeviceVisorPrism,
	kDeviceVisorPlatinum,
	kDeviceVisorEdge,
	kDeviceLast
};

struct DeviceInfo
{
	int			fDeviceID;

	const char*	fDeviceMenuName;	// This string appears in the Device menu.

	const char*	fDeviceNames[8];	// These strings can be specified on the command line
									// to specify that this device be emulated.  The first
									// string in the array is also the "preferred" string,
									// in that it is used to identify the device in the
									// Preferences and Session files.

	uint32		fFlags;				// One or more of the flags below.

	RAMSizeType	fMinRAMSize;		// Minimum RAM size (in K).  Used to prune back the
									// RAM size menu.

	long		fHardwareID;		// Some devices have a hardware ID they report via
									// hardware register munging.

	long		fHardwareSubID;		// Some devices have a hardware sub-ID they report via
									// hardware registr munging.

	struct
	{
		uint32		fCompanyID;		// The "companyID" field in a v5 CardHeader.  This field
									// is used to identify which ROMs can run on which devices.
									// Set it to zero if the ROM for your device doesn't have
									// a v5 CardHeader.

		uint32		fHalID;			// The "halID" field in a v5 CardHeader.  This field
									// is used to identify which ROMs can run on which devices.
									// Set it to zero if the ROM for your device doesn't have
									// a v5 CardHeader.

	}			fCardHeaderInfo[1];	// It's possible that in the future, more than one HAL
									// could properly execute on this device.  Make this an
									// array so that we can add more than one HAL ID.
};


// (None of these values are (is?) exposed, so they can be freely reordered.)

static const uint32	kSupports68328			= 0x00000001;
static const uint32	kSupports68EZ328		= 0x00000002;
static const uint32	kSupports68VZ328		= 0x00000004;
static const uint32	kSupports68SZ328		= 0x00000008;
static const uint32	kSupportsARM			= 0x00000010;

static const uint32	kHasFlash				= 0x00000100;

static const long	hwrMiscFlagIDNone		= 0xFF;
static const long	hwrMiscFlagExtSubIDNone	= 0xFF;

#define UNSUPPORTED			0


/* Miscellaneous symbols used to discriminate between ROMs. Do not assume that
   these are meant to convey actual ownership or documented interfaces. */
   
#define PALM_MANUF			"Palm Computing"
#define HANDSPRING_MANUF	"Handspring, Inc."
#define SYMBOL_DB			"ScanMgr"
#define SYMBOL_1500_DB		"ResetApp"			// But not available in 3.5 version of 1500 ROM
#define SYMBOL_1700_DB		"ResetAppScan"		// But now also available in 3.5 version of 1500 ROM
#define SYMBOL_1740_DB		"S24PowerDown"		// Only on 1740s, which have the Spectrum 24 wireless
#define PALM_VII_DB			"WMessaging"
#define PALM_VII_IF1_DB		"RAM NetIF"
#define PALM_VII_IF2_DB		"RAM NetIFRM"
#define PALM_VII_EZ_NEW_DB	"TuneUp"
#define PALM_VIIX_DB		"iMessenger"
#define PALM_m100_DB		"cclkPalmClock"


// Table used to describe the various hardware devices we support.
// Some good summary background information is at:
//
//	<http://www.palmos.com/dev/tech/hardware/compare.html>

static const DeviceInfo kDeviceInfo[] =
{
	// ===== Palm Devices =====
	{
		kDevicePilot, "Pilot",
		{ "Pilot", "Pilot1000", "Pilot5000", "TD", "Touchdown" },
		kSupports68328, 128, hwrMiscFlagIDTouchdown, hwrMiscFlagExtSubIDNone,
	},
	{
		kDevicePalmPilot, "PalmPilot",
		{ "PalmPilot", "PalmPilotPersonal", "PalmPilotProfessional", "Striker" },
		kSupports68328, 128, hwrMiscFlagIDPalmPilot, hwrMiscFlagExtSubIDNone,
	},
	{
		kDevicePalmIII, "Palm III",
		{ "PalmIII", "Rocky" },
		kSupports68328 + kHasFlash, 512, hwrMiscFlagIDRocky, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'rcky' }}
	},
	{
		kDevicePalmIIIc, "Palm IIIc",
		{ "PalmIIIc", "Austin", "ColorDevice" },
		kSupports68EZ328 + kHasFlash, 8192, hwrMiscFlagIDPalmIIIc, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'astn' }}
	},
	{
		kDevicePalmIIIe, "Palm IIIe",
		{ "PalmIIIe", "Robinson" },
		kSupports68EZ328, 2048, hwrMiscFlagIDBrad, hwrMiscFlagExtSubIDBrad,
	},
	{
		kDevicePalmIIIx, "Palm IIIx",
		{ "PalmIIIx", "Brad" },
		kSupports68EZ328 + kHasFlash, 4096, hwrMiscFlagIDBrad, hwrMiscFlagExtSubIDBrad,
		{{ 'palm', 'sumo' }}
	},
	{
		kDevicePalmV, "Palm V",
		{ "PalmV", "Razor", "Sumo" },
		kSupports68EZ328 + kHasFlash, 2048, hwrMiscFlagIDSumo, hwrMiscFlagExtSubIDSumo,
		{{ 'palm', 'sumo' }}
	},
	{
		kDevicePalmVx, "Palm Vx",
		{ "PalmVx", "Cobra" },
		kSupports68EZ328 + kHasFlash, 8192, hwrMiscFlagIDSumo, hwrMiscFlagExtSubIDCobra,
		{{ 'palm', 'sumo' }}
	},
	{
		kDevicePalmVII, "Palm VII",
		{ "PalmVII", "Jerry", "Eleven" },
		kSupports68328 + kHasFlash, 2048, hwrMiscFlagIDJerry, hwrMiscFlagExtSubIDNone,
	},
	{
		kDevicePalmVIIEZ, "Palm VII (EZ)",
		{ "PalmVIIEZ", "Bonanza" },
		kSupports68EZ328 + kHasFlash, 2048, hwrMiscFlagIDJerryEZ, 0,
										// sub-id *should* be hwrMiscFlagExtSubIDNone, but
										// a bug in Rangoon (OS 3.5 for Palm VII EZ) has it
										// accidentally looking for and using the sub-id. In
										// order to get the hard keys to work, we need to
										// return zero here.
	},
	{
		kDevicePalmVIIx, "Palm VIIx",
		{ "PalmVIIx", "Octopus" },
		kSupports68EZ328 + kHasFlash, 8192, hwrMiscFlagIDJerryEZ, hwrMiscFlagExtSubIDBrad,
										// David Mai says that he *guesses* that the sub-id is zero
	},
	{
		kDevicePalmM100, "Palm m100",
		{ "PalmM100", "m100", "Calvin" },
		kSupports68EZ328, 2048, hwrMiscFlagIDm100, hwrMiscFlagExtSubIDBrad,
		{{ 'palm', 'clvn' }}
	},
	{
		kDevicePalmM125, "Palm m125",
		{ "PalmM125", "m120", "m125", "m110", "m115", "JV", "Stu" },
		kSupports68VZ328 + kHasFlash, 2048, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'vstu' }}
	},
	{
		kDevicePalmM130, "Palm m130",
		{ "PalmM130", "m130", "Hobbes", "PalmM130" },
		kSupports68VZ328, 8192, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'vhbs' }}
	},
	{
		kDevicePalmM500, "Palm m500",
		{ "PalmM500", "m500", "Tornado" },
		kSupports68VZ328 + kHasFlash, 8192, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'vtrn' }}
	},
	{
		kDevicePalmM505, "Palm m505",
		{ "PalmM505", "m505", "EmeraldCity", "VZDevice" },
		kSupports68VZ328 + kHasFlash, 8192, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'ecty' }}
	},
	{
		kDevicePalmM515, "Palm m515",
		{ "PalmM515", "m515", "PalmM525", "m525", "Lighthouse", "GatorReef" },
		kSupports68VZ328 + kHasFlash, 16384, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'vlit' }}
	},
	{
		kDevicePalmI705, "Palm i705",
		{ "PalmI705", "i705", "Everest", "PalmI705" },
		kSupports68VZ328 + kHasFlash, 8192, hwrMiscFlagIDNone, hwrMiscFlagExtSubIDNone,
		{{ 'palm', 'skyw' }}
	},
	{
		kDeviceARMRef, "ARM Ref",
		{ "ARMRef" },
		kSupportsARM, 0, 0
	},

	// ===== Symbol devices =====
	{
		kDeviceSymbol1500, "Symbol 1500",
		{ "Symbol1500" },
		kSupports68328 + kHasFlash, 2048, hwrMiscFlagIDRocky, hwrMiscFlagExtSubIDNone,
	},
	{
		kDeviceSymbol1700, "Symbol 1700",
		{ "Symbol1700" },
		kSupports68328 + kHasFlash, 2048, hwrMiscFlagIDRocky, hwrMiscFlagExtSubIDNone,
	},
	{
		kDeviceSymbol1740, "Symbol 1740",
		{ "Symbol1740" },
		kSupports68328 + kHasFlash, 2048, hwrMiscFlagIDRocky, hwrMiscFlagExtSubIDNone,
	},

	// ===== TRG/HandEra devices =====

	{
		kDeviceTRGpro, "TRGpro",
		{ "TRGpro" },
		kSupports68EZ328 + kHasFlash, 8192, hwrOEMCompanyIDTRG, hwrTRGproID,
		{{ 'trgp', 'trg1' }}
	},

	{
		kDeviceHandEra330, "HandEra 330",
		{ "HandEra330" },
		kSupports68VZ328 + kHasFlash, 8192, hwrOEMCompanyIDTRG, hwrTRGproID + 1,
		{{ 'trgp', 'trg2' }}
	},

	// ===== Handspring devices =====
	{
		kDeviceVisor, "Visor",
		{ "Visor", "Lego" },
		kSupports68EZ328, 2048, halModelIDLego, 0,	// Hardware ID for first Visor
	},
	{
		kDeviceVisorPlatinum, "Visor Platinum",
		{ "VisorPlatinum" },
		kSupports68VZ328, 8192, halModelIDVisorPlatinum, 0
	},
	{
		kDeviceVisorPrism, "Visor Prism",
		{ "VisorPrism" },
		kSupports68VZ328, 8192, halModelIDVisorPrism, 0
	},
	{
		kDeviceVisorEdge, "Visor Edge",
		{ "VisorEdge" },
		kSupports68VZ328, 8192, halModelIDVisorEdge, 0
	}
};


/***********************************************************************
 *
 * FUNCTION:    EmDevice::EmDevice
 *
 * DESCRIPTION: Constructors
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Nothing
 *
 ***********************************************************************/

EmDevice::EmDevice (void) :
	fDeviceID (kDeviceUnspecified)
{
}


EmDevice::EmDevice (int id) :
	fDeviceID (id)
{
}


EmDevice::EmDevice (const char* s) :
	fDeviceID (this->GetDeviceID (s))
{
}


EmDevice::EmDevice (const string& s) :
	fDeviceID (this->GetDeviceID (s.c_str ()))
{
}


EmDevice::EmDevice (const EmDevice& other) :
	fDeviceID (other.fDeviceID)
{
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::~EmDevice
 *
 * DESCRIPTION: Destructor
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Nothing
 *
 ***********************************************************************/

EmDevice::~EmDevice (void)
{
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::operator==
 * FUNCTION:    EmDevice::operator!=
 *
 * DESCRIPTION: Destructor
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Nothing
 *
 ***********************************************************************/

bool EmDevice::operator== (const EmDevice& other) const
{
	return fDeviceID == other.fDeviceID;
}


bool EmDevice::operator!= (const EmDevice& other) const
{
	return fDeviceID != other.fDeviceID;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::Supported
 *
 * DESCRIPTION: Returns whether or not this EmDevice represents a device
 *				we currently support emulating.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::Supported (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return info != NULL;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::Supports68328
 *
 * DESCRIPTION: Returns whether or not this device is based on the
 *				MC68328.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::Supports68328 (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kSupports68328) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::Supports68EZ328
 *
 * DESCRIPTION: Returns whether or not this device is based on the
 *				MC68EZ328.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::Supports68EZ328 (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kSupports68EZ328) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::Supports68VZ328
 *
 * DESCRIPTION: Returns whether or not this device is based on the
 *				MC68VZ328.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::Supports68VZ328 (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kSupports68VZ328) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::Supports68SZ328
 *
 * DESCRIPTION: Returns whether or not this device is based on the
 *				MC68SZ328.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::Supports68SZ328 (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kSupports68SZ328) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::SupportsARM
 *
 * DESCRIPTION: Returns whether or not this device is based on the
 *				MC68VZ328.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::SupportsARM (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kSupportsARM) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::PrismPlatinumEdgeHack
 *
 * DESCRIPTION: Handspring's Prism, Platinum, and Edge have card headers
 *				saying they run on EZ's when they really run on VZ's.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::PrismPlatinumEdgeHack (void) const
{
	return	fDeviceID == kDeviceVisorPrism ||
			fDeviceID == kDeviceVisorPlatinum ||
			fDeviceID == kDeviceVisorEdge;
}


/***********************************************************************
 *
 * FUNCTION:	EmDevice::EdgeHack
 *
 * DESCRIPTION:	Handspring's Edge uses bit 3 of port D for powered-cradle
 *				detection, so we need to apply a few hacks.
 *
 * PARAMETERS:	None
 *
 * RETURNED:	True if so.
 *
 ***********************************************************************/

Bool EmDevice::EdgeHack (void) const
{
	return fDeviceID == kDeviceVisorEdge;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::SupportsROM
 *
 * DESCRIPTION: Returns whether or not this device can support the
 *				execution of a particular ROM.
 *
 * PARAMETERS:  A reference to an EmROMReader object. Hopefully one
 *				that has successfully acquired the details of a ROM.
 *
 * RETURNED:    True if ROM is supported by device.
 *
 ***********************************************************************/

Bool EmDevice::SupportsROM (const EmFileRef& romFileRef) const
{
	// Load the ROM image into memory.

	EmStreamFile	romStream (romFileRef, kOpenExistingForRead);
	StMemory    	romImage (romStream.GetLength ());

	romStream.GetBytes (romImage.Get (), romStream.GetLength ());

	// Create a ROM Reader on the ROM image.

	EmROMReader reader (romImage.Get (), romStream.GetLength ());

	// Grovel over the ROM.

	if (reader.AcquireCardHeader ())
	{
		UInt16	version = reader.GetCardVersion ();

		if (version < 5)
		{
			reader.AcquireROMHeap ();
			reader.AcquireDatabases ();
			reader.AcquireFeatures ();
			reader.AcquireSplashDB ();
		}
	}

	return this->SupportsROM (reader);
}


Bool EmDevice::SupportsROM (const EmROMReader& ROM) const
{
	/* If the ROM is recent enough, use the embedded hardware ID information
	   to determine whether it will work with this device */

	if (ROM.GetCardVersion () >= 5)
	{
		const DeviceInfo*	info = this->GetDeviceInfo ();

		for (size_t ii = 0; ii < countof (info->fCardHeaderInfo); ++ii)
		{
			if (info->fCardHeaderInfo[ii].fCompanyID &&
				info->fCardHeaderInfo[ii].fHalID &&
				info->fCardHeaderInfo[ii].fCompanyID == ROM.GetCompanyID () &&
				info->fCardHeaderInfo[ii].fHalID == ROM.GetHalID ())
			{
				return true;
			}
		}

		return false;
	}

	/* Otherwise, we will use miscellaneous pieces of data to heuristically
	   discriminate between ROMs. Do not assume that any of these tests are
	   meant to convey ownership or documented interfaces. */

	bool is7		= ROM.ContainsDB (PALM_VII_IF1_DB) || ROM.ContainsDB (PALM_VII_IF2_DB);
	bool is328		= (ROM.GetCardVersion () <= 2) || ROM.GetFlag328 ();
	bool isColor	= ROM.GetSplashChunk () && (ROM.IsBitmapColor (*ROM.GetSplashChunk (), true) == 1);

	if (Supports68328 () && !is328)
		return false;
	else if (Supports68EZ328 () && !ROM.GetFlagEZ ())
		return false;
	else if (Supports68VZ328 () && !ROM.GetFlagVZ ())
	{
		/*	Make a hack for the Prism, Platinum and Edge below since
			Handspring seems to report the EZ bit in their ROMs. */

		if (!this->PrismPlatinumEdgeHack ())
		{
			return false;
		}
	}

	switch (fDeviceID)
	{
		case kDeviceUnspecified:
			return false;
			break;

		case kDevicePilot:
			if ((ROM.Version () < 0x020000) &&
				(ROM.GetCardManufacturer () == PALM_MANUF)
				)
				return true;
			break;

		case kDevicePalmPilot:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () >= 0x020000) &&
				(ROM.Version () < 0x030000)
				)
				return true;
			break;

		case kDevicePalmIII:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () >= 0x030000) &&
				!ROM.ContainsDB (SYMBOL_DB) &&
				!is7
				)
				return true;
			break;

		case kDevicePalmIIIc:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				!ROM.ContainsDB (PALM_m100_DB) &&
				!is7 &&
				isColor
				)
				return true;
			break;

		case kDevicePalmIIIe:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				!ROM.ContainsDB (PALM_m100_DB) &&
				!is7 &&
				!isColor &&
				(ROM.Version () == 0x030100)
				)
				return true;
			break;

		case kDevicePalmIIIx:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				!ROM.ContainsDB (PALM_m100_DB) &&
				!is7 &&
				!isColor
				)
				return true;
			break;

		case kDevicePalmV:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				!ROM.ContainsDB (PALM_m100_DB) &&
				!is7 &&
				!isColor
				)
				return true;
			break;

		case kDevicePalmVx:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				!ROM.ContainsDB (PALM_m100_DB) &&
				!is7 &&
				!isColor &&
				(ROM.Version () >= 0x030300)
				)
				return true;
			break;

		case kDevicePalmVII:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () >= 0x030000) &&
				!ROM.ContainsDB (SYMBOL_DB) &&
				is7
				)
				return true;
			break;

		case kDevicePalmVIIEZ:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				is7 &&
				(!ROM.ContainsDB (PALM_VIIX_DB) ||
				 ROM.ContainsDB (PALM_VII_EZ_NEW_DB)) &&
				!isColor
				)
				return true;
			break;

		case kDevicePalmVIIx:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				is7 &&
				ROM.ContainsDB (PALM_VIIX_DB) &&
				!ROM.ContainsDB (PALM_VII_EZ_NEW_DB) &&
				!isColor
				)
				return true;
			break;

		case kDevicePalmM100:
			if (ROM.ContainsDB (PALM_m100_DB))
				return true;
			break;

		case kDeviceSymbol1500:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () < 0x030500) &&
				ROM.ContainsDB (SYMBOL_1500_DB) &&
				!ROM.ContainsDB (SYMBOL_1700_DB) &&
				!ROM.ContainsDB (SYMBOL_1740_DB)
				)
				return true;
			break;

		case kDeviceSymbol1700:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () < 0x030500) &&
				!ROM.ContainsDB (SYMBOL_1500_DB) &&
				ROM.ContainsDB (SYMBOL_1700_DB) &&
				!ROM.ContainsDB (SYMBOL_1740_DB)
				)
				return true;
			break;

		case kDeviceSymbol1740:
			if ((ROM.GetCardManufacturer () == PALM_MANUF) &&
				(ROM.Version () < 0x030500) &&
				!ROM.ContainsDB (SYMBOL_1500_DB) &&
				ROM.ContainsDB (SYMBOL_1700_DB) &&
				ROM.ContainsDB (SYMBOL_1740_DB)
				)
				return true;
			break;

		case kDeviceTRGpro:
		case kDeviceHandEra330:
			if (ROM.GetCardManufacturer () == TRGPRO_MANUF)
				return true;
			break;

		case kDeviceVisor:
			if ((ROM.GetCardManufacturer () == HANDSPRING_MANUF) &&
				(ROM.Version () == 0x030100)
				)
				return true;
			break;

		case kDeviceVisorPrism:
			if ((ROM.GetCardManufacturer () == HANDSPRING_MANUF) &&
				(ROM.Version () >= 0x030500)
				)
				return true;
			break;

		case kDeviceVisorPlatinum:
			if ((ROM.GetCardManufacturer () == HANDSPRING_MANUF) &&
				(ROM.Version () >= 0x030500)
				)
				return true;
			break;

		case kDeviceVisorEdge:
			if ((ROM.GetCardManufacturer () == HANDSPRING_MANUF) &&
				(ROM.Version () >= 0x030500)
				)
				return true;
			break;

		case kDeviceLast:
			EmAssert (false);
			break;

		default:
			break;
	}

	return false;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::CreateCPU
 *
 * DESCRIPTION: Create the CPU object.
 *
 * PARAMETERS:  session - EmSession object used to initialize the CPU
 *					object.
 *
 * RETURNED:    Pointer to the created object.  Caller is responsible
 *				for destroying the object when it's done with it.
 *
 ***********************************************************************/

EmCPU* EmDevice::CreateCPU (EmSession* session) const
{
	EmCPU*	result = NULL;

	if (this->Supports68328 () ||
		this->Supports68EZ328 () ||
		this->Supports68VZ328 () ||
		this->Supports68SZ328 ())
	{
		result = new EmCPU68K (session);
	}
	else if (this->SupportsARM ())
	{
		result = new EmCPUARM (session);
	}

	EmAssert (result);

	return result;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::CreateRegs
 *
 * DESCRIPTION: Create the register object that manages the Dragonball
 *				(or derivative) hardware registers.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Pointer to the created object.  Caller is responsible
 *				for destroying the object when it's done with it.
 *
 ***********************************************************************/

void EmDevice::CreateRegs (void) const
{
	switch (fDeviceID)
	{
		case kDevicePilot:
			EmBankRegs::AddSubBank (new EmRegs328Pilot);
			break;

		case kDevicePalmPilot:
			EmBankRegs::AddSubBank (new EmRegs328PalmPilot);
			break;

		case kDevicePalmIII:
			EmBankRegs::AddSubBank (new EmRegs328PalmIII);
			break;

		case kDevicePalmIIIc:
			EmBankRegs::AddSubBank (new EmRegsEZPalmIIIc);
			EmBankRegs::AddSubBank (new EmRegsSED1375 ((emuptr) sed1375RegsAddr, sed1375BaseAddress));
			EmBankRegs::AddSubBank (new EmRegsFrameBuffer (sed1375BaseAddress, sed1375VideoMemSize));
			break;

		case kDevicePalmIIIe:
			EmBankRegs::AddSubBank (new EmRegsEZPalmIIIe);
			break;

		case kDevicePalmIIIx:
			EmBankRegs::AddSubBank (new EmRegsEZPalmIIIx);
			break;

		case kDevicePalmV:
			EmBankRegs::AddSubBank (new EmRegsEZPalmV);
			break;

		case kDevicePalmVx:
			EmBankRegs::AddSubBank (new EmRegsEZPalmVx);
			break;

		case kDevicePalmVII:
			EmBankRegs::AddSubBank (new EmRegs328PalmVII);
			break;

		case kDevicePalmVIIEZ:
			EmBankRegs::AddSubBank (new EmRegsEZPalmVII);
			EmBankRegs::AddSubBank (new EmRegsPLDPalmVIIEZ);
			break;

		case kDevicePalmVIIx:
			EmBankRegs::AddSubBank (new EmRegsEZPalmVIIx);
			EmBankRegs::AddSubBank (new EmRegsPLDPalmVIIEZ);
			break;

		case kDevicePalmM100:
			EmBankRegs::AddSubBank (new EmRegsEZPalmM100);
			break;

		case kDevicePalmM125:
			EmBankRegs::AddSubBank (new EmRegsVZPalmM125);
			EmBankRegs::AddSubBank (new EmRegsUSBPhilipsPDIUSBD12 (0x1F000000));
			break;

		case kDevicePalmM130:
			EmBankRegs::AddSubBank (new EmRegsVZPalmM130);
			EmBankRegs::AddSubBank (new EmRegsMediaQ11xx (MMIO_BASE, T_BASE));
			EmBankRegs::AddSubBank (new EmRegsFrameBuffer (T_BASE, MMIO_OFFSET));
			break;

		case kDevicePalmM500:
			EmBankRegs::AddSubBank (new EmRegsVZPalmM500);
			EmBankRegs::AddSubBank (new EmRegsUSBPhilipsPDIUSBD12 (0x10400000));
			break;

		case kDevicePalmM505:
			EmBankRegs::AddSubBank (new EmRegsVZPalmM505);
			EmBankRegs::AddSubBank (new EmRegsSED1376PalmGeneric (sed1376RegsAddr, sed1376VideoMemStart));
			EmBankRegs::AddSubBank (new EmRegsFrameBuffer (sed1376VideoMemStart, sed1376VideoMemSize));
			EmBankRegs::AddSubBank (new EmRegsUSBPhilipsPDIUSBD12 (0x10400000));
			break;

		case kDevicePalmM515:
			EmBankRegs::AddSubBank (new EmRegsVZPalmM505);
			EmBankRegs::AddSubBank (new EmRegsSED1376PalmGeneric (sed1376RegsAddr, sed1376VideoMemStart));
			EmBankRegs::AddSubBank (new EmRegsFrameBuffer (sed1376VideoMemStart, sed1376VideoMemSize));
			EmBankRegs::AddSubBank (new EmRegsUSBPhilipsPDIUSBD12 (0x10400000));
			break;

		case kDevicePalmI705:
			EmBankRegs::AddSubBank (new EmRegsVZPalmI705);
			EmBankRegs::AddSubBank (new EmRegsPLDPalmI705 (0x11000000));
			EmBankRegs::AddSubBank (new EmRegsUSBPhilipsPDIUSBD12 (0x1F000000));
			break;

		case kDeviceARMRef:
			break;

		case kDeviceSymbol1500:
			EmBankRegs::AddSubBank (new EmRegs328PalmIII);
			break;

		case kDeviceSymbol1700:
			EmBankRegs::AddSubBank (new EmRegs328Symbol1700);
			EmBankRegs::AddSubBank (new EmRegsASICSymbol1700);
			break;

		case kDeviceSymbol1740:
			EmBankRegs::AddSubBank (new EmRegs328Symbol1700);
			EmBankRegs::AddSubBank (new EmRegsASICSymbol1700);
			break;

		case kDeviceTRGpro:
			OEMCreateTRGRegObjs (hwrTRGproID);
			break;

 		case kDeviceHandEra330:
			OEMCreateTRGRegObjs (hwrTRGproID + 1);
			break;

		case kDeviceVisor:
			EmBankRegs::AddSubBank (new EmRegsEZVisor);
			EmBankRegs::AddSubBank (new EmRegsUSBVisor);
			break;

		case kDeviceVisorPrism:
			EmBankRegs::AddSubBank (new EmRegsVZVisorPrism);
			EmBankRegs::AddSubBank (new EmRegsSED1376VisorPrism (0x11800000, 0x11820000));
			EmBankRegs::AddSubBank (new EmRegsFrameBuffer (0x11820000, 80 * 1024L));
			EmBankRegs::AddSubBank (new EmRegsUSBVisor);
			break;

		case kDeviceVisorPlatinum:
			EmBankRegs::AddSubBank (new EmRegsVZVisorPlatinum);
			EmBankRegs::AddSubBank (new EmRegsUSBVisor);
			break;

		case kDeviceVisorEdge:
			EmBankRegs::AddSubBank (new EmRegsVZVisorEdge);
			EmBankRegs::AddSubBank (new EmRegsUSBVisor);
			break;

		default:
			break;
	}

	EmHAL::EnsureCoverage ();
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::HasFlash
 *
 * DESCRIPTION: Returns whether or not this device uses Flash RAM.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    True if so.
 *
 ***********************************************************************/

Bool EmDevice::HasFlash (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return (info->fFlags & kHasFlash) != 0;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::MinRAMSize
 *
 * DESCRIPTION: Returns the minimum RAM size that this device should
 *				be configured with.  Some devices can't operate lower
 *				than the levels they ship with, as they run out of
 *				memory and crash.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Minimum RAM size, in K (so 1024 == 1 Meg).
 *
 ***********************************************************************/

RAMSizeType EmDevice::MinRAMSize (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();
	return info->fMinRAMSize;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::HardwareID
 *
 * DESCRIPTION: Returns the hardware ID of this device.  This ID is the
 *				one that eventually gets put into GHwrMiscGFlags by
 *				HwrIdentifyFeatures.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    The device's hardware ID.
 *
 ***********************************************************************/

long EmDevice::HardwareID (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();

//	EmAssert (info->fHardwareID != hwrMiscFlagIDNone);

	return info->fHardwareID;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::HardwareSubID
 *
 * DESCRIPTION: Returns the hardware ID of this device.  This ID is the
 *				one that eventually gets put into GHwrMiscGFlags by
 *				HwrIdentifyFeatures.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    The device's hardware ID.
 *
 ***********************************************************************/

long EmDevice::HardwareSubID (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();

	EmAssert (info->fHardwareSubID != hwrMiscFlagExtSubIDNone);

	return info->fHardwareSubID;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetMenuString
 *
 * DESCRIPTION: .
 *
 * PARAMETERS:  None
 *
 * RETURNED:    .
 *
 ***********************************************************************/

string EmDevice::GetMenuString (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();

	return string (info->fDeviceMenuName);
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetIDString
 *
 * DESCRIPTION: .
 *
 * PARAMETERS:  None
 *
 * RETURNED:    .
 *
 ***********************************************************************/

string EmDevice::GetIDString (void) const
{
	const DeviceInfo*	info = this->GetDeviceInfo ();

	return string (info->fDeviceNames[0]);
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetIDStrings
 *
 * DESCRIPTION: .
 *
 * PARAMETERS:  None
 *
 * RETURNED:    .
 *
 ***********************************************************************/

StringList EmDevice::GetIDStrings (void) const
{
	StringList			result;

	const DeviceInfo*	info = this->GetDeviceInfo ();

	size_t ii = 0;
	while (ii < countof (info->fDeviceNames) && info->fDeviceNames[ii])
	{
		result.push_back (string (info->fDeviceNames[ii]));
		++ii;
	}

	return result;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetDeviceList
 *
 * DESCRIPTION: Return the list of devices Poser emulates.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Collection containing the results.
 *
 ***********************************************************************/

EmDeviceList EmDevice::GetDeviceList (void)
{
	EmDeviceList	result;

	for (size_t ii = 0; ii < countof (kDeviceInfo); ++ii)
	{
		const DeviceInfo*	info = &kDeviceInfo[ii];

		result.push_back (EmDevice (info->fDeviceID));
	}

	return result;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetDeviceInfo
 *
 * DESCRIPTION: Look up and return the DeviceInfo block for the
 *				managed device.
 *
 * PARAMETERS:  None
 *
 * RETURNED:    Const pointer to the DeviceInfo block.
 *
 ***********************************************************************/

const DeviceInfo* EmDevice::GetDeviceInfo (void) const
{
	for (size_t ii = 0; ii < countof (kDeviceInfo); ++ii)
	{
		const DeviceInfo*	info = &kDeviceInfo[ii];

		if (info->fDeviceID == fDeviceID)
			return info;
	}

	return NULL;
}


/***********************************************************************
 *
 * FUNCTION:    EmDevice::GetDeviceID
 *
 * DESCRIPTION: Look up and return the unique ID for the
 *				managed device.
 *
 * PARAMETERS:  s - a string identifying the device.  Can be any of the
 *					strings in the fDeviceNames in the DeviceInfo array.
 *					The comparison to this string is case-insensitive.
 *
 * RETURNED:    The device's unique ID.  kDeviceUnspecified if a match
 *				could not be found.
 *
 ***********************************************************************/

int EmDevice::GetDeviceID (const char* s) const
{
	// Iterate over each entry in the kDeviceInfo array.

	for (size_t ii = 0; ii < countof (kDeviceInfo); ++ii)
	{
		const DeviceInfo*	info = &kDeviceInfo[ii];

		// Iterate over each string in the fDeviceNames array.

		size_t jj = 0;
		while (jj < countof (info->fDeviceNames) && info->fDeviceNames[jj])
		{
			// If we find a match, return the unique ID.

			if (_stricmp (info->fDeviceNames[jj], s) == 0)
			{
				return info->fDeviceID;
			}

			++jj;
		}
	}

	// No match.

	return kDeviceUnspecified;
}