initial import
[picodrive.git] / platform / readme.txt
1 \r
2 About\r
3 -----\r
4 \r
5 This version of PicoDrive is another enhanced version of Dave's\r
6 Megadrive / Genesis emulator for Pocket PC. The original Dave's code was\r
7 heavily modified (including Cyclone core), parts of it were rewritten in\r
8 asm, many features added, accuracy increased. This version is aimed at\r
9 ARM-based handheld devices, so ports exist for GP2X handheld console,\r
10 Symbian smartphones and PocketPC devices.\r
11 \r
12 \r
13 How to make it run\r
14 ------------------\r
15 \r
16 GP2X:\r
17 Copy PicoDrive.gpe, code940.bin and mmuhack.o to any place in your filesystem\r
18 (all 3 files must be in the same directory) and run PicoDrive.gpe.\r
19 Then load a ROM and enjoy!\r
20 \r
21 Symbian:\r
22 Select PicoDrive from application (tools) menu and run it. That's it!\r
23 \r
24 All:\r
25 If you have any problems (game does not boot, sound is glitchy, broken graphics),\r
26 make sure you enable "Accurate timing", "Emulate Z80" and then disable\r
27 "Fast renderer". This way you will get the best compatibility this emulator can\r
28 provide.\r
29 \r
30 \r
31 Configuration\r
32 -------------\r
33 \r
34 See config.txt file.\r
35 \r
36 \r
37 Problems / limitations\r
38 ----------------------\r
39 \r
40 * 32x, Sega CD, SVP are not emulated.\r
41 * Various VDP quirks (window bug, scroll size 2, etc.) are not emulated,\r
42   as very few games use this.\r
43 * Some games don't work or have glitches because of inaccurate timing and sync\r
44   between the emulated chips.\r
45 \r
46 \r
47 Credits\r
48 -------\r
49 \r
50 This emulator uses code from these people/projects:\r
51 \r
52 Dave\r
53 Cyclone 68000 core, Pico emulation library\r
54 Homepage: http://www.finalburn.com/\r
55 \r
56 notaz\r
57 GP2X port, Cyclone 68000 hacks, lots of additional coding (see changelog).\r
58 \r
59 Reesy & FluBBa\r
60 DrZ80, the Z80 emulator written in ARM assembly.\r
61 Homepage: http://reesy.gp32x.de/\r
62 \r
63 Tatsuyuki Satoh, Jarek Burczynski, MultiArcadeMachineEmulator development\r
64 software implementation of Yamaha FM sound generator\r
65 \r
66 MultiArcadeMachineEmulator (MAME) development\r
67 Texas Instruments SN76489 / SN76496 programmable tone /noise generator\r
68 Homepage: http://www.mame.net/\r
69 \r
70 \r
71 Additional thanks\r
72 -----------------\r
73 \r
74 * Charles MacDonald (http://cgfm2.emuviews.com/) for old but still very useful\r
75   info about genesis hardware.\r
76 * Stéphane Dallongeville for creating Gens and making it open-source.\r
77 * Steve Snake for all that he has done for Genesis emulation scene.\r
78 * Bart Trzynadlowski for his SSFII and 68000 docs.\r
79 * Haze for his research (http://haze.mameworld.info).\r
80 * Mark and Jean-loup for zlib library.\r
81 * Anyone else I forgot. You know who you are.\r
82 \r
83 GP2X:\r
84 * rlyeh and all the other people behind the minimal library.\r
85 * Squidge for his famous squidgehack(tm).\r
86 * Dzz for his ARM940 sample code.\r
87 * GnoStiC & Puck2099 for USB joystick support.\r
88 * Hermes PS2R, god_at_hell for the CpuCtrl library.\r
89 * craigix for supplying the GP2X hardware and making this port possible.\r
90 \r
91 Symbian:\r
92 * Peter van Sebille for his various open-source Symbian projects to learn from.\r
93 * Steve Fischer for his open-source Motorola projects.\r
94 * The development team behind "Symbian GCC Improvement Project"\r
95   (http://www.inf.u-szeged.hu/symbian-gcc/) for their updated pre-SymbianOS9\r
96   compile tools.\r
97 * AnotherGuest for all his Symbian stuff and support.\r
98 * Inder for the icons.\r
99 \r
100 \r
101 Changelog\r
102 ---------\r
103 0.964\r
104   * GP2X: Fixed a sound buffer underflow issue on lower sample rate modes, which was\r
105           happening for NTSC games and causing sound clicks.\r
106   * GP2X: Redone key config to better support USB joysticks (now multiple joysticks\r
107           should be useable and configurable).\r
108   + GP2X: Added save confirmation option.\r
109   + GP2X: Added 940 CPU crash detection.\r
110   + ALL:  UIQ3 port added.\r
111 \r
112 0.963\r
113   * GP2X: Gamma-reset-on-entering-menu bug fixed.\r
114   * GP2X: Recompiled PicoDrive with gcc profiling option set as described here:\r
115           http://www.gp32x.com/board/index.php?showtopic=28490\r
116 \r
117 0.962\r
118   * GP2X: Fixed an issue with incorrect sounds in some games when dualcore operation\r
119           was enabled (for example punch sound in SOR).\r
120   * GP2X: Limited max volume to 90, because higher values often cause distortions.\r
121   * GP2X: Fixed a bug with lower res scaling.\r
122   * GP2X: Gamma is now reset on exit.\r
123 \r
124 0.96\r
125   * ALL:  Severely optimized MAME's YM2612 core, part of it is now rewritten in asm.\r
126   + GP2X: The YM2612's code now can be run in GP2X's ARM940T CPU, what causes large\r
127           performance increase.\r
128   * ALL:  Accurate renderers are slightly faster now.\r
129   + GP2X: Using quadruple buffering instead of doublebuffer now, also updated\r
130           framelimitter, this should eliminate some scrolling and tearing problems.\r
131   * GP2X: Fixed some flickering issues of 8bit accurate renderer.\r
132   + GP2X: craigix's RAM timings now can be enabled in the menu (see advanced options).\r
133   + GP2X: Added ability to save config for specific games only.\r
134   + GP2X: Gamma control added (using GP2X's hardware capabilities for this).\r
135   * GP2X: Volume keys are now configurable.\r
136   + GP2X: GnoStiC added USB joystick support, I made it possible to use it for\r
137           player 2 control (currently untested).\r
138   * GP2X: squidgehack is now applied through kernel module (cleaner way).\r
139 \r
140 0.95\r
141   * ALL:  Fixed a bug in sprite renderer which was causing slowdowns for some games.\r
142   + GP2X: Added command line support\r
143   + GP2X: Added optional hardware scaling for lower-res games like Shining Force.\r
144   * ALL:  Sound chips are now sampled 2 times per frame. This fixed some games which\r
145           had missing sounds (Vectorman 2 1st level, Thunder Force 3 water level,\r
146               etc.).\r
147   + ALL:  Added another accurate 8-bit renderer which is slightly faster and made it\r
148           default.\r
149 \r
150 0.945\r
151   + GP2X: Added frame limiter for frameskipped modes.\r
152   * GP2X: Increased brightness a bit (unused pixel bits now also contain data).\r
153   * GP2X: Suidgehack was not applied correctly (was applied before allocating some\r
154           high memory and had no effect).\r
155 \r
156 0.94\r
157   + Added GP2X port.\r
158   * Improved interrupt timing, Mazin Saga and Burning Force now works.\r
159   * Rewritten renderer code to better suit GP2X, should be faster on other\r
160     ports too.\r
161   + Added support for banking used by 12-in-1 and 4-in-1 ROMs (thanks Haze).\r
162   + Added some protection device faking, used by some unlicensed games like\r
163     Super Bubble Bobble, King of Fighters, Elf Wor, ... (thanks to Haze again)\r
164   + Added primitive Virtua Racing SVP faking, so menus can be seen now.\r
165 \r
166 0.93\r
167   * Fixed a problem with P900/P910 key configuration in FC mode.\r
168   * Improved shadow/hilight mode emulation. Still not perfect, but should be\r
169     enough for most games.\r
170   + Save state slots added.\r
171   + Region selector added.\r
172 \r
173 0.92\r
174   VDP changes:\r
175   * VDP emulation is now more accurate (fixes flickering in Chase HQ II,\r
176     Super Hang-On and some other problems in other games).\r
177   * HV counter emulation is now much more accurate. Fixes the Asterix games,\r
178     line in Road Rash 3, etc.\r
179   * Minor sprite and layer scroll masking bugs fixed.\r
180   + Added partial interlace mode renderer (Sonic 2 vs mode)\r
181   * Fixed a crash in both renderers when certain size window layers were used.\r
182   + Added emulation of shadow/hilight operator sprites. Other shadow/hilight\r
183     effects are still unemulated.\r
184   + Sprite emulation is more accurate, sprite limit is emulated.\r
185   + Added "accurate sprites" option, which always draws sprites in correct\r
186     order and emulates sprite collision bit, but is significantly slower.\r
187 \r
188   Emulation changes:\r
189   * Improved interrupt handling, added deferred interrupt emulation\r
190     (Lemmings, etc).\r
191   + Added serial EEPROM SRAM support (Wonder Boy in Monster World,\r
192     Megaman - The Wily Wars and many EA sports games like NBA Jam).\r
193   + Implemented ROM banking for Super Street Fighter II - The New Challengers\r
194   * Updated to the latest version of DrZ80 core, integrated memory handlers\r
195     in it for better performance. A noticeable performance increase, but save\r
196         states may not work from the previous version (you can only use them with\r
197         sound disabled in that case).\r
198   + SRAM word read handler was using incorrect byte order, fixed.\r
199 \r
200   Changes in Cyclone 0.0086:\r
201   + Added missing CHK opcode handler (used by SeaQuest DSV).\r
202   + Added missing TAS opcode handler (Gargoyles,Bubba N Stix,...). As in real genesis,\r
203     memory write-back phase is ignored (but can be enabled in config.h if needed).\r
204   + Added missing NBCD and TRAPV opcode handlers.\r
205   + Added missing addressing mode for CMP/EOR.\r
206   + Added some minor optimizations.\r
207   - Removed 216 handlers for 2927 opcodes which were generated for invalid addressing modes.\r
208   + Fixed flags for ASL, NEG, NEGX, DIVU, ADDX, SUBX, ROXR.\r
209   + Bugs fixed in MOVEP, LINK, ADDQ, DIVS handlers.\r
210   * Undocumented flags for CHK, ABCD, SBCD and NBCD are now emulated the same way as in Musashi.\r
211   + Added Uninitialized Interrupt emulation.\r
212   + Altered timing for about half of opcodes to match Musashi's.\r
213 \r
214 0.80\r
215   * Nearly all VDP code was rewritten in ARM asm. Gives ~10-25% performance\r
216     increase (depends on game).\r
217   * Optimized 32-column renderer not to render tiles offscreen, games which\r
218     use 32-column display (like Shining Force) run ~50% faster.\r
219   + Added new "Alternative renderer", which gives another ~30-45% performance\r
220     increase (in addition to mentioned above), but works only with some games,\r
221     because it is missing some features (it uses tile-based renderering\r
222     instead of default line-based and disables H-ints).\r
223   + Added "fit2" display mode for all FC gamers. It always uses 208x146 for\r
224     P800 and 208x208 for all other phones.\r
225   + Added volume control for Motorolas (experimental).\r
226 \r
227   VDP changes:\r
228   + Added support for vertical window (used by Vapor Trail, Mercs, GRIND\r
229     Stormer and others).\r
230   + Added sprite masking (hiding), adds some speed.\r
231   + Added preliminary H counter emulation. Comix Zone and Sonic 3D Blast\r
232     special stage are now playable.\r
233   + Added column based vertical scrolling (Gunstar Heroes battleship level,\r
234     Sonic and Knuckles lava boss, etc).\r
235 \r
236   Emulation changes:\r
237   + Re-added and improved Z80 faking when Z80 is disabled. Many games now can\r
238     be played without enabling Z80 (Lost Vikings, Syndicate, etc), but some\r
239     still need it (International Superstar Soccer Deluxe).\r
240   * Improved ym2612 timers, Outrun music plays at correct speed, voices in\r
241     Earthworm Jim play better, more games play sound.\r
242   * I/O registers now remember their values (needed for Pirates! Gold)\r
243   + Added support for 6 button pad.\r
244 \r
245   Changes in Cyclone 0.0083wip:\r
246   + Added missing CHK opcode (used by SeaQuest DSV).\r
247   + Added missing TAS opcode (Gargoyles). As in real genesis, write-back phase\r
248     is ignored (but is enabled for other systems).\r
249 \r
250   Backported stuff from Snes9x:\r
251   * Fixed Pxxx jog up/down which were not working in game.\r
252   + Added an option to gzip save states to save space.\r
253   + The emulator now pauses whenever it is loosing focus, so it will now pause\r
254     when alarm/ponecall/battery low/... windows come up.\r
255   - Removed 'pause on phonecall' feature, as it is no longer needed.\r
256   + Video fix for asian A1000s.\r
257 \r
258 0.70\r
259   * Started using tools from "Symbian GCC Improvement Project", which give\r
260     considerable speed increase (~4fps in "center 90" mode).\r
261   * Rewrote some drawing routines in ARM assembly (gives ~6 more fps in\r
262     "center 90" mode).\r
263   * Minor improvement to 0 and 180 "fit" modes. Now they look slightly better\r
264     and are faster.\r
265   * Minor stability improvements (emulator is less likely to crash).\r
266   + Added some background for OSD text for better readability.\r
267   + Added Pal/NTSC detection. This is needed for proper sound speed.\r
268   + Implemented Reesy's DrZ80 Z80 emu. Made some changes to it with hope to make\r
269     it faster.\r
270   + Implemented ym2612 emu from the MAME project. Runs well but sometimes sounds\r
271     a bit weird. Could be a little faster, so made some changes too.\r
272   + Implemented SN76489 emu from the MAME project.\r
273   + Added two separate sound output methods (mediaserver and cmaudiofb) with\r
274     autodetection (needs testing).\r
275   * Fixed VDP DMA fill emulation (as described in Charles MacDonald's docs),\r
276     fixes Contra and some other games.\r
277 \r
278 0.301\r
279   Launcher:\r
280   * Launcher now starts emulation process from current directory,\r
281     not from hardcoded paths.\r
282   * Improved 'pause on call' feature, should hopefully work with Motorola phones.\r
283 \r
284 0.30\r
285   Initial release.\r
286 \r
287 \r
288 Disclaimer\r
289 ----------\r
290 \r
291 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" \r
292 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE \r
293 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE \r
294 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE \r
295 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR \r
296 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF \r
297 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
298 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
299 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \r
300 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
301 POSSIBILITY OF SUCH DAMAGE. \r