Add __ARM_ARCH_7S__ architecture
[pcsx_rearmed.git] / readme.txt
303ee308 1
4ea086f6 2PCSX-ReARMed - yet another PCSX fork, ARM special
303ee308 3
c9dbba7f 4
303ee308 6
10PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
11which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
12version is ARM architecture oriented and features MIPS->ARM recompiler by
3938f69a 13Ari64, NEON GTE code and more performance improvements. It was created for
14Pandora handheld, but should be usable on other devices after some code
4ea086f6 15adjustments (N900, GPH Wiz/Caanoo, PlayBook versions are also available).
303ee308 16
c069dc1b 17PCSX ReARMed features ARM NEON GPU by Exophase, that in many cases produces
18pixel perfect graphics at very high performance. There is also Una-i's GPU
19plugin from PCSX4ALL project, and traditional P.E.Op.S. one.
303ee308 20
06d2e1a5 22Compiling
3aba4185 25For libretro build, just doing "make -f Makefile.libretro" is recommended as
26it's the way libretro team is building the core and only Makefile.libretro is
27maintained by them.
29For standalone build, './configure && make' should work for the most part.
06d2e1a5 30
31When compiling for ARM, it's advisable to tell configure script the CPU, FPU
32and ABI that matches your target system to get best performance, like this:
34CFLAGS='-mcpu=cortex-a8 -mtune=cortex-a8 -mfpu=neon -mfloat-abi=softfp' ./configure
36Cross compilation should also work if kernel-style CROSS_COMPILE variable
37is set:
38CROSS_COMPILE='arm-none-linux-gnueabi-' ./configure
303ee308 41Usage
06d2e1a5 44There are several different frontends that can be built from source (one
45generic and several platform specific), so usage slightly differs depending
46on that. Most of them have a menu that can be used to run games and configure
47the emulator.
303ee308 48
33716956 49Supported CD image formats:
f932e54b 50- .bin/.cue
51- .bin/.toc
52- .img/.ccd/.sub
53- .mdf/.mds
303ee308 54- .Z/.Z.table
33716956 55- .bz/.bz.table
56- .ZNX/.ZNX.table (partial)
57- EBOOT.PBP (PSP, partial)
bab59f00 58- .cbn
303ee308 59
7ca0ce80 60CDDA (CD audio) only supported when .cue/.toc/.ccd/.mds files are present.
900acfae 61There is support for .sbi files, which can be used instead of
62.sub files to save space (name it the same as .cue/.bin, just use .sbi
63extension). This is required for Libcrypt copy protected game support.
303ee308 64
c9dbba7f 65The emulator can simulate BIOS, which means BIOS files are not required,
66however implementation is not complete and some games still need real BIOS
06d2e1a5 67to work. To use real BIOS, copy uncompressed BIOS files to bios/ directory
68which itself should be in main emulator directory.
70For pandora, it should be:
c9dbba7f 71[sd card]/pandora/appdata/pcsx_rearmed/bios/
06d2e1a5 72
73When the file is copied, BIOS should be selected in Options->BIOS/Plugins menu.
c9dbba7f 74
b0c8d18b 75On pandora, analog controllers are supported using nubs, but this is
76disabled by default and needs to be enabled in 'Controls' menu.
7ca0ce80 77There is also touchscreen based GunCon support, which also requires
78appropriate controller selected in controls configuration.
799b0b87 79
303ee308 80
ee78346e 81Plugins
84GPU (graphics) and SPU (sound) plugins can be selected in
85[BIOS/Plugins] menu:
c069dc1b 87builtin_gpu - this is either Exophase's ARM NEON GPU (accurate and fast,
06d2e1a5 88 available if platform supports NEON, like on pandora),
4ea086f6 89 gpu_peops or gpu_unai (depends on compile options). - P.E.Op.S. soft GPU, reasonably accurate but slow
91 (also found with older emulators on PC) - Unai's plugin from PCSX4ALL project. Faster than P.E.Op.S.
c069dc1b 93 but has some glitches.
4ea086f6 - experimental port of P.E.Op.S. MesaGL plugin to OpenGL ES.
ee78346e 95 Occasionally faster but has lots of glitches and seems to
4ea086f6 96 be rather unstable (may crash the driver/system).
c069dc1b 97builtin_spu - P.E.Op.S. SPU plugin, optimized for ARM.
ee78346e - NULL plugin, i.e. no sound emulation.
4ea086f6 99 May cause compatibility problems.
ee78346e 100
9c27c205 102Cheats
105PCSX and cwcheat cheat formats are supported. PCSX .cht file can be loaded from
106"extra stuff" menu after game is loaded, while cwcheat cheats are automatically
107loaded from cheatpops.db file, if one is present in emulator's directory and
108has any cheats for the loaded game in it.
109If any of those files are successfully loaded, 'cheats' option will appear in
110the main menu where it is possible to enable/disable individual cheats.
9af2e936 113Changelog
52d279a5 116r21 (2015-01-12)
117+ general: added ability to run SPU emulation on a separate thread, enabled it
118 by default when multicore CPU is detected. Significant effort was made to
119 avoid any compatibility problems which the old P.E.Op.S. implementation had.
120+ pandora: added ability to run SPU emulation on TI C64x DSP by using bsp's
121 c64_tools.
122* libretro: fixed win32 build (mingw only)
123* some tweaks for the scanline effect and other things
3aba4185 125r20 (2014-12-25)
126* fixed various sound accuracy issues, like effects in ff7-ff9
127 for standalone build, audio will no longer slow down when emu is not fast
128 enough and stutter instead, as the former behavior causes accuracy issues.
129 Old mode can be restored in SPU plugin config options, but is not recommended.
130* savestates now save small parts of dynarec state to reduce dynarec related
131 slowdowns after savestate load
132* menu: fixed file browser issues with filesystems like exfat-fuse
133* menu: memcard manager: selected card is saved in config now
134* standalone: added some basic scanline efect
135* some CD image loading fixes
136* converted asm code to be compatible with more assemblers, like Apple's gas
137+ libretro: added Makefile.libretro and support for various platforms like
138 iOS and QNX. Makefile.libretro is recommended way to do libretro builds
139 (patches from CatalystG, squarepusher, notaz and others, see git).
140* some other minor fixes
101e053c 142r19 (2013-03-17)
143+ libretro: added region, multidisk support
144* more work on cdrom code
145* changed sound sync code
146* fixed masking bugs in NEON GPU (in collaboration with Exophase)
147* fixed some compatibility issues
148* various other tweaks and fixes
d77e7438 150r18 (2013-01-06)
151* cdrom code greatly cleaned up
152+ new GLES output mode for ARM Linux/R-Pi
153* various libretro improvements
154* fixed several compatibility regressions
155* various other tweaks and fixes
157r17 (2012-11-24)
06d2e1a5 158+ added overlay support for generic Linux build
159* attempted to fix sound breakage with PulseAudio
160* fixed some regressions caused by hires mode code
161* fixed some sound issues introduced in r9
162* various other tweaks
e7b8bfad 164r16 (2012-11-10)
165+ gpu_neon now has new hires rendering mode
166 (sometimes slow and occasionally glitchy)
167+ integrated M-HT's scale2x and eagle2x filters
168 (works for 512x256 or lower resolution games)
169+ pandora: added gamma/brightness control (requires SZ 1.52)
170* pandora: some improvements for nub support
171+ added fast forward support
172* fixed some glitches after loading savestates from r14 or earlier
4ea086f6 174r15 (2012-08-02)
175* various compatibility fixes
176* attempts to fix various SPU issues
177* Exophase fixed blending issue in his NEON GPU
178* fixed some potential crashes
179* gpu_unai: merged range fix from Franxis
180+ added cheat support
181+ menu: pressing a key in file list now seeks to a file
182+ new code, fixes and refactoring to improve portability:
183 support RAM offset, translation cache in data segment,
184 SDL support, multiple sound output methods, configure script
185* unified plugin names for all ports
186+ initial libretro support
ea1f6f2f 188r14 (2012-03-04)
189* GLES GPU: implemented frameskip
190* GLES GPU: merged some changes from schtruck/FPSE
191* Caanoo: potential workaround for save corruption
192 (always exit emulator cleanly before turning off the console
193 to reduce chance of corruption)
194* Caanoo: fixed a bug in GTE code (graphic glitches in some games)
195* Caanoo: reworked vibration support, should support more games
196* various refactoring/minor tweaks
3ce7adeb 198r13 (2012-01-09)
199* yet more fixes for regressions from earlier versions
200* various fixes for NEON GPU (in collaboration with Exophase)
201+ NEON GPU supports interlace mode now, but it's not always
202 enabled due to frameskip glithes (can be changed in the menu)
203* cdda should resume on savestate load now
204* fixed date display in menus to honour locale
205+ pandora: added support for minimizing the emulator (while ingame only)
c069dc1b 207r12 (2011-12-24)
208+ new ARM NEON GPU rasterizer from Exophase (NEON hardware required)
209+ new GPU emulation code
210+ new analog controller configurator
211* changed frameskip handling (again..), higher values supported
212* fixed several more regressions from earlier versions
213* changed cdrom code with hope for better compatibility
214* sprite optimization for PCSX4ALL plugin
215+ Caanoo: added vibration support
b0c8d18b 217r11 (2011-10-31)
218+ added Wiz support
219* Caanoo: fixed tv-out
220+ Caanoo/Wiz: added scaling (16bpp only)
221+ Caanoo/Wiz: added touchscreen-as-buttons input (4 sections)
222+ added .cbin support
223+ added multidisk eboot support (use "next multidisk CD" in exras menu)
224* some GTE related optimizations
225* various other optimizations
226+ added some speed hack options for slower devices
227 (get more speed at stability and correctness loss)
228* fixed several compatibility issues
229* fixed a few crash situations
230* various minor adjustments
231* maemo: merged some code from Bonapart
232* maemo: fixed BIOS issue (hopefully)
cbd45cda 234r10 (2011-10-10)
235+ added Caanoo port
236+ completely rewrote memory handlers
aaac9c7e 237+ added fixed frameskip option
cbd45cda 238+ added ability to change PSX clock
239+ implemented GTE dead flag detection
240* switched to larger timeslices for better performance
241* fixed some cases of flickering
aaac9c7e 242* fixed a crash in PCSX4ALL GPU plugin
243* fixed several dynarec compatibility related issues (hopefully)
cbd45cda 244* fixed multiple SPU regressions from r9 and earlier
aaac9c7e 245* fixed frame limiter issue that sometimes caused stuttering
246* fixed some minor GUI issues
7ca0ce80 248r9 (2011-08-13)
249* fixed various dynarec integration issues that were causing instability
250* merged latest Ari64 dynarec code for some performance improvement
251* changed frameskip handling in builtin and PCSX4ALL plugins,
252 fixes some cases where it would not work
253* merged PCSX4ALL 2.2 GPU code to it's plugin
254* fixed PCSX4ALL GPU inline asm, was miscompiling for ARMv7.
255+ added CDDA handling for eboot format
256* improved CDDA handling for all image formats that support it
257* various compatibility/accuracy improvements
258* optimized PEOPS SPU core
259* various menu adjustments
260* changed scaling options a bit, there are now two 4:3 options:
261 integer and fractional
262+ added some basic memory card manager, which allows to change
263 or remove cards (remove needed for Tenka)
264+ added GunCon support
265+ added gpuPEOPS2 plugin (peops rendering + new emulation code)
3938f69a 267r8 (2011-03-22)
268* improved recompiler performance for some games
269* fixed a few recompiler related compatibility issues
270 (also fixes broken memcard support in some games)
271* fixed some graphics problems caused by frameskip.
272 Note that not all problems were fixed, so if you see graphics
273 glitches try turning off frameskip or using different GPU plugin.
274+ added screenshot function
275+ added some code to attempt to sync with pandora's LCD better
276* merged a few compatibility fixes from PCSX-Reloaded
277* fixed and issue with external controllers
278* added experimental ability to use nubs as buttons
900acfae 280r7 (2011-03-02)
281+ implemented most used GTE operations in NEON
282* merged latest Ari64's recompiler patches
283* removed some code from the recompiler that is unneeded for R3k
284* added some special handlers for constant reads
285* some moderate builtin GPU and SPU optimizations
286+ added SBI support
287* tuned frameskip code again
288* fixed one 'analog controller not working' issue
289* fixed a crash in builtin gpu code
290* fixed cdrom slowdown issue
291* fixed my stupid bug in the recompiler that slowed down
292 recompilation a lot
293* some other refactoring
acb57d8d 295r6 (2011-02-10)
296+ added analog controller support using nubs (disabled by default)
297+ added control config saving
298+ added support for ingame actions (eg. savestate load)
299+ added 'auto' region option and made it default
300+ added cd swap functionality
301+ added maemo frontend from Bonapart
302 (with some tuning, source code only)
303* reworked key configuration to be less confusing
304* fixed 'SPU IRQ wait' option sometimes causing noise
305 and turned it on by default
306* fixed mono xa masking (was causing noise)
307* fixed word access macros in dfxvideo (darkness problem)
308* changed GPU DMA timing back to 1.92 levels
309* backported more fixes from PCSX-Reloaded project
310 (mostly shalma's work, see GIT)
311* fixed a few more recompiler issues
312+ fixed frameskip in builtin plugin
5b09a334 314r5 (2011-01-31)
315+ added support for .bz format, also partial support for
316 .znx and eboot.pbp formats
317+ merged latest cdrom code from PCSX-Reloaded project
318* fixed remaining savestate incompatibilities between PCSX4ALL
319 and P.E.Op.S. GPU plugins
320* fixed channel disable preventing irqs in P.E.Op.S. SPU plugin
321* fixed some alignment issues
322+ added handling for branches in delay slots
323+ fixed some unexpected drops to menu
324* fixed lots of recompiler related issues (see GIT)
325+ added watchdog thread to detect emulator lockups
326* minor frontend adjustments
c9dbba7f 328r4 (2011-01-15)
329+ added real BIOS support (and various things for it to work)
330* fixed various recompiler issues
331+ added interpreter option (useful to overcome dynarec bugs)
332* fixed some memory card related issues with HLE bios
333* rewrote frame limiter (old was sometimes sleeping needlessly)
ee78346e 335r3 (2011-01-05):
336+ added Pickle's port of gpu-gles from psx4m project
337+ added PCSX4ALL gpu as a plugin
338* improved gpu plugin support
339+ added savestate preview
340* various frontend fixes
342r2 (2010-12-29):
9af2e936 343* fixed memcard paths
344* fixed a keybind copy-paste bug
345* properly implemented pad handling
ee78346e 346 (inputs no longer control both emulated pads at once)
9af2e936 347* fixed a crash caused by framebuffer out of range access
348* fixed SWL/SWR handling (usually resulted in graphic glitches)
349* fixed BxxZAL (Medal of Honor)
350* fixed alignment crash in color space conversion code (Lunar)
351* fixed SWC2 occasional use of wrong address register (Parasite Eve)
352* fixed firstfile() handling in HLE BIOS (broken memory cards in some games)
353+ added per-game configs (controls still not saved though)
354+ added simple plugin select interface to the menu
ee78346e 356r1 (2010-12-25):
9af2e936 357* initial release
303ee308 360Credits / License
f932e54b 363Emulator core:
303ee308 365(C) 1999-2003 PCSX Team
6b8a7b88 366 (c) 1998 Vision Thing
367 Linuzappz <>
368 Shadow <>
369 Pete Bernett <>
370 NoComp <>
371 Nik3d
372 Akumax <>
303ee308 374(C) 2005-2009 PCSX-df Team
6b8a7b88 375 (c) Ryan Schultz <>
376 (c) Andrew Burton <>
377 (c) Stephen Chao <>
378 (c) Marcus Comstedt <>
379 Stefan Sikora <>
900acfae 381(C) 2009-2011 PCSX-Reloaded Team
6b8a7b88 382 edgbla (Root counters, various core/plugin fixes)
900acfae 383 shalma (GTE Divider, many core improvements, sound plugin fixes)
6b8a7b88 384 Firnis (GTE code from PCSX-Revolution Project)
385 Gabriele Gorla (MDEC decoder)
6b8a7b88 386 Peter Collingbourne (Various core/psxbios fixes)
ee78346e 387 Dario, NeToU, siveritas (Various bugfixes)
6b8a7b88 388 Wei Mingzhi (Maintainer, input plugin, iso/cheat support, misc stuff)
c069dc1b 390NEON GPU plugin:
3ce7adeb 391 (C) 2011-2012 Exophase
392 (C) 2011-2012 notaz
c069dc1b 393
ee78346e 394PCSX4ALL GPU plugin:
395 (C) 2010 PCSX4ALL Team
396 (C) 2010 Unai
397 Franxis <>
398 Chui <>
400GLES plugin (psx4m project):
f932e54b 401 (C) 1999-2009 by Pete Bernert
402 EQ
403 Olli Hinkka
404 Proger
405 Pickle
c069dc1b 407P.E.Op.S. GPU plugin:
1775933a 408 (C) Pete Bernert and the P.E.Op.S. team
c069dc1b 410P.E.Op.S. SPU plugin:
1775933a 411 (C) Pete Bernert and the P.E.Op.S. team
412 (C) SPU2-X, gigaherz, Pcsx2 Development Team
413 shalma
c069dc1b 414 notaz
f932e54b 415
416MIPS->ARM recompiler:
1775933a 417 (C) 2009-2011 Ari64
6b8a7b88 418
f932e54b 419integration, optimization and frontend:
3ce7adeb 420 (C) 2010-2012 notaz
422Special thanks to Mednafen author, shalma/gretar and Rokas for
423various help while developing this emulator.
303ee308 424
3ce7adeb 425Some implementation ideas (and maybe code?) likely originated from
22d3b349 426MAME/smf/pSXauthor and were integrated by various people to PCSX.
303ee308 428Source code is released under GNU GPL license, version 2 or later.
3ce7adeb 429See COPYING included in the archive (pandora version's .pnd can be
430extracted using unsquashfs).
303ee308 432The source code is available in a GIT repository at: