WindEmu/README.md

WindEmu is an attempt to emulate various Psion PDAs.

- Platform-independent core emulation library written in C/C++
- Qt5 front-end (currently quite barebones...)
- Very experimental
- Basic support for multiple devices

Psion 5mx (EPOC R5) features:

- ✅ LCD: partially implemented
- ✅ Keyboard: implemented
- ✅ Touch panel: implemented
- ❌ Audio: not implemented
- ❌ Serial/UART support: stubbed out
- ❌ ETNA (PCMCIA/CompactFlash): mostly stubbed out
- ✅ RTC: implemented
- ❌ RTC alarm: not implemented
- ❌ Standby mode: not implemented

Oregon Scientific Osaris (EPOC R4) features:

- ✅ LCD: implemented
- ✅ Keyboard: implemented (somewhat buggy)
- ✅ Touch panel: implemented
- ❌ Audio: not implemented
- ❌ Serial/UART support: stubbed out
- ❌ PCMCIA: mostly stubbed out
- ✅ RTC: implemented (needs testing)
- ❌ RTC alarm: not implemented
- ❌ Standby mode: not implemented

Known issues:

- Some keys do not work properly
- State is not saved (just like a real Psion :p)
- EPOC misbehaves massively with memory banks larger than 0x800000 (may be an OS design flaw? need to confirm)

Copyright
---------

The Psion-specific code is copyright (c) 2019 Ash Wolf.

The ARM disassembly code is a modified version of the one used in [mGBA](https://github.com/mgba-emu/mgba) by endrift. 

WindEmu is available under the Mozilla Public License 2.0.

Resources
---------

Special thanks to [PsiLinux/OpenPsion](http://linux-7110.sourceforge.net/index.shtml) for providing an avenue to learn about the 5mx hardware definitions (registers, etc).

More information on the 5mx hardware is available in the NetBSD port: http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/arch/epoc32/?only_with_tag=MAIN

The EPOC C++ SDK is available here: https://web.archive.org/web/20071010101808/http://www.psionteklogix.com/teknet/pdk/netpad-pdk/epoc_downloads.htm

The ARM variant used in the 5mx is documented here: http://infocenter.arm.com/help/topic/com.arm.doc.ddi0033d/DDI0033D_710a_prelim_ds.pdf

The datasheet for the CL-PS7110 SoC used in the Series 5 (_not_ the 5mx) is available here: https://www.igorkov.org/revo/datasheets/CL-PS7110.pdf - while not identical to Windermere, some components operate in similar fashion.

The datasheet for the CL-PS7111 SoC used in the Osaris is available here: https://www.digchip.com/datasheets/parts/datasheet/096/CL-PS7111-pdf.php

The datasheet for the CL-PS6700 PCMCIA controller used in the Osaris is available here: https://pdf1.alldatasheet.com/datasheet-pdf/view/104907/CIRRUS/CL-PS6700.html
make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`WindEmu is an attempt to emulate various Psion PDAs.`
initial commit 2019-12-19 00:27:23 +00:00
			`- Platform-independent core emulation library written in C/C++`
			`- Qt5 front-end (currently quite barebones...)`
			`- Very experimental`
make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`- Basic support for multiple devices`
initial commit 2019-12-19 00:27:23 +00:00
make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`Psion 5mx (EPOC R5) features:`
initial commit 2019-12-19 00:27:23 +00:00
			`- ✅ LCD: partially implemented`
			`- ✅ Keyboard: implemented`
fix broken timekeeping on 5mx and touch panel on 5mx 2019-12-25 19:25:34 +00:00			`- ✅ Touch panel: implemented`
initial commit 2019-12-19 00:27:23 +00:00			`- ❌ Audio: not implemented`
			`- ❌ Serial/UART support: stubbed out`
add skeleton support for the Etna chip, including PROM support 2019-12-20 23:46:22 +00:00			`- ❌ ETNA (PCMCIA/CompactFlash): mostly stubbed out`
initial commit 2019-12-19 00:27:23 +00:00			`- ✅ RTC: implemented`
			`- ❌ RTC alarm: not implemented`
			`- ❌ Standby mode: not implemented`

make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`Oregon Scientific Osaris (EPOC R4) features:`

			`- ✅ LCD: implemented`
fix broken timekeeping on 5mx and touch panel on 5mx 2019-12-25 19:25:34 +00:00			`- ✅ Keyboard: implemented (somewhat buggy)`
implement touch panel for Osaris 2019-12-25 14:46:08 +00:00			`- ✅ Touch panel: implemented`
make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`- ❌ Audio: not implemented`
			`- ❌ Serial/UART support: stubbed out`
			`- ❌ PCMCIA: mostly stubbed out`
			`- ✅ RTC: implemented (needs testing)`
			`- ❌ RTC alarm: not implemented`
			`- ❌ Standby mode: not implemented`

initial commit 2019-12-19 00:27:23 +00:00			`Known issues:`

			`- Some keys do not work properly`
			`- State is not saved (just like a real Psion :p)`
			`- EPOC misbehaves massively with memory banks larger than 0x800000 (may be an OS design flaw? need to confirm)`

			`Copyright`
			`---------`

			`The Psion-specific code is copyright (c) 2019 Ash Wolf.`

make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`The ARM disassembly code is a modified version of the one used in [mGBA](https://github.com/mgba-emu/mgba) by endrift.`
initial commit 2019-12-19 00:27:23 +00:00
			`WindEmu is available under the Mozilla Public License 2.0.`

			`Resources`
			`---------`

make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`Special thanks to [PsiLinux/OpenPsion](http://linux-7110.sourceforge.net/index.shtml) for providing an avenue to learn about the 5mx hardware definitions (registers, etc).`
initial commit 2019-12-19 00:27:23 +00:00
make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`More information on the 5mx hardware is available in the NetBSD port: http://cvsweb.netbsd.org/bsdweb.cgi/src/sys/arch/epoc32/?only_with_tag=MAIN`
add physical address display to memory viewer 2019-12-20 22:25:05 +00:00
initial commit 2019-12-19 00:27:23 +00:00			`The EPOC C++ SDK is available here: https://web.archive.org/web/20071010101808/http://www.psionteklogix.com/teknet/pdk/netpad-pdk/epoc_downloads.htm`

			`The ARM variant used in the 5mx is documented here: http://infocenter.arm.com/help/topic/com.arm.doc.ddi0033d/DDI0033D_710a_prelim_ds.pdf`

			`The datasheet for the CL-PS7110 SoC used in the Series 5 (_not_ the 5mx) is available here: https://www.igorkov.org/revo/datasheets/CL-PS7110.pdf - while not identical to Windermere, some components operate in similar fashion.`

make Osaris and 5mx emulator classes inherit from a shared base 2019-12-25 00:29:03 +00:00			`The datasheet for the CL-PS7111 SoC used in the Osaris is available here: https://www.digchip.com/datasheets/parts/datasheet/096/CL-PS7111-pdf.php`

			`The datasheet for the CL-PS6700 PCMCIA controller used in the Osaris is available here: https://pdf1.alldatasheet.com/datasheet-pdf/view/104907/CIRRUS/CL-PS6700.html`

initial commit 2019-12-19 00:27:23 +00:00