psxmem: Writes to PIO Expansion area have no effect.
[pcsx_rearmed.git] / libpcsxcore / psxmem.c
1 /***************************************************************************
2  *   Copyright (C) 2007 Ryan Schultz, PCSX-df Team, PCSX team              *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   51 Franklin Street, Fifth Floor, Boston, MA 02111-1307 USA.           *
18  ***************************************************************************/
19
20 /*
21 * PSX memory functions.
22 */
23
24 // TODO: Implement caches & cycle penalty.
25
26 #include "psxmem.h"
27 #include "psxmem_map.h"
28 #include "r3000a.h"
29 #include "psxhw.h"
30 #include "debug.h"
31
32 #include "memmap.h"
33
34 #ifdef USE_LIBRETRO_VFS
35 #include <streams/file_stream_transforms.h>
36 #endif
37
38 #ifndef MAP_ANONYMOUS
39 #define MAP_ANONYMOUS MAP_ANON
40 #endif
41
42 boolean writeok = TRUE;
43
44 #ifndef NDEBUG
45 #include "debug.h"
46 #else
47 void DebugCheckBP(u32 address, enum breakpoint_types type) {}
48 #endif
49
50 void *(*psxMapHook)(unsigned long addr, size_t size, int is_fixed,
51                 enum psxMapTag tag);
52 void (*psxUnmapHook)(void *ptr, size_t size, enum psxMapTag tag);
53
54 void *psxMap(unsigned long addr, size_t size, int is_fixed,
55                 enum psxMapTag tag)
56 {
57 #ifdef LIGHTREC
58 #ifdef MAP_FIXED_NOREPLACE
59         int flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED_NOREPLACE;
60 #else
61         int flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED;
62 #endif
63 #else
64         int flags = MAP_PRIVATE | MAP_ANONYMOUS;
65 #endif
66
67         int try_ = 0;
68         unsigned long mask;
69         void *req, *ret;
70
71 retry:
72         if (psxMapHook != NULL) {
73                 ret = psxMapHook(addr, size, 0, tag);
74                 if (ret == NULL)
75                         return NULL;
76         }
77         else {
78                 /* avoid MAP_FIXED, it overrides existing mappings.. */
79                 /* if (is_fixed)
80                         flags |= MAP_FIXED; */
81
82                 req = (void *)addr;
83                 ret = mmap(req, size, PROT_READ | PROT_WRITE, flags, -1, 0);
84                 if (ret == MAP_FAILED)
85                         return NULL;
86         }
87
88         if (addr != 0 && ret != (void *)addr) {
89                 SysMessage("psxMap: warning: wanted to map @%08x, got %p\n",
90                         addr, ret);
91
92                 if (is_fixed) {
93                         psxUnmap(ret, size, tag);
94                         return NULL;
95                 }
96
97                 if (((addr ^ (unsigned long)ret) & ~0xff000000l) && try_ < 2)
98                 {
99                         psxUnmap(ret, size, tag);
100
101                         // try to use similarly aligned memory instead
102                         // (recompiler needs this)
103                         mask = try_ ? 0xffff : 0xffffff;
104                         addr = ((unsigned long)ret + mask) & ~mask;
105                         try_++;
106                         goto retry;
107                 }
108         }
109
110         return ret;
111 }
112
113 void psxUnmap(void *ptr, size_t size, enum psxMapTag tag)
114 {
115         if (psxUnmapHook != NULL) {
116                 psxUnmapHook(ptr, size, tag);
117                 return;
118         }
119
120         if (ptr)
121                 munmap(ptr, size);
122 }
123
124 s8 *psxM = NULL; // Kernel & User Memory (2 Meg)
125 s8 *psxP = NULL; // Parallel Port (64K)
126 s8 *psxR = NULL; // BIOS ROM (512K)
127 s8 *psxH = NULL; // Scratch Pad (1K) & Hardware Registers (8K)
128
129 u8 **psxMemWLUT = NULL;
130 u8 **psxMemRLUT = NULL;
131
132 /*  Playstation Memory Map (from Playstation doc by Joshua Walker)
133 0x0000_0000-0x0000_ffff         Kernel (64K)
134 0x0001_0000-0x001f_ffff         User Memory (1.9 Meg)
135
136 0x1f00_0000-0x1f00_ffff         Parallel Port (64K)
137
138 0x1f80_0000-0x1f80_03ff         Scratch Pad (1024 bytes)
139
140 0x1f80_1000-0x1f80_2fff         Hardware Registers (8K)
141
142 0x1fc0_0000-0x1fc7_ffff         BIOS (512K)
143
144 0x8000_0000-0x801f_ffff         Kernel and User Memory Mirror (2 Meg) Cached
145 0x9fc0_0000-0x9fc7_ffff         BIOS Mirror (512K) Cached
146
147 0xa000_0000-0xa01f_ffff         Kernel and User Memory Mirror (2 Meg) Uncached
148 0xbfc0_0000-0xbfc7_ffff         BIOS Mirror (512K) Uncached
149 */
150
151 int psxMemInit() {
152         int i;
153
154         psxMemRLUT = (u8 **)malloc(0x10000 * sizeof(void *));
155         psxMemWLUT = (u8 **)malloc(0x10000 * sizeof(void *));
156         memset(psxMemRLUT, 0, 0x10000 * sizeof(void *));
157         memset(psxMemWLUT, 0, 0x10000 * sizeof(void *));
158
159 #ifdef LIGHTREC
160         psxM = psxMap(0x30000000, 0x00210000, 1, MAP_TAG_RAM);
161         if (psxM == NULL)
162                 psxM = psxMap(0x70000000, 0x00210000, 1, MAP_TAG_RAM);
163
164 #else
165         psxM = psxMap(0x80000000, 0x00210000, 1, MAP_TAG_RAM);
166 #endif
167 #ifndef RAM_FIXED
168         if (psxM == NULL)
169                 psxM = psxMap(0x77000000, 0x00210000, 0, MAP_TAG_RAM);
170 #endif
171         if (psxM == NULL) {
172                 SysMessage(_("mapping main RAM failed"));
173                 return -1;
174         }
175
176         psxP = &psxM[0x200000];
177 #ifdef LIGHTREC
178         psxH = psxMap(0x4f800000, 0x10000, 0, MAP_TAG_OTHER);
179         if (psxH == NULL)
180                 psxH = psxMap(0x8f800000, 0x10000, 0, MAP_TAG_OTHER);
181
182         psxR = psxMap(0x4fc00000, 0x80000, 0, MAP_TAG_OTHER);
183         if (psxR == NULL)
184                 psxR = psxMap(0x8fc00000, 0x80000, 0, MAP_TAG_OTHER);
185 #else
186         psxH = psxMap(0x1f800000, 0x10000, 0, MAP_TAG_OTHER);
187         psxR = psxMap(0x1fc00000, 0x80000, 0, MAP_TAG_OTHER);
188 #endif
189
190         if (psxMemRLUT == NULL || psxMemWLUT == NULL || 
191             psxR == NULL || psxP == NULL || psxH == NULL) {
192                 SysMessage(_("Error allocating memory!"));
193                 psxMemShutdown();
194                 return -1;
195         }
196
197 // MemR
198         for (i = 0; i < 0x80; i++) psxMemRLUT[i + 0x0000] = (u8 *)&psxM[(i & 0x1f) << 16];
199
200         memcpy(psxMemRLUT + 0x8000, psxMemRLUT, 0x80 * sizeof(void *));
201         memcpy(psxMemRLUT + 0xa000, psxMemRLUT, 0x80 * sizeof(void *));
202
203         psxMemRLUT[0x1f00] = (u8 *)psxP;
204         psxMemRLUT[0x1f80] = (u8 *)psxH;
205
206         for (i = 0; i < 0x08; i++) psxMemRLUT[i + 0x1fc0] = (u8 *)&psxR[i << 16];
207
208         memcpy(psxMemRLUT + 0x9fc0, psxMemRLUT + 0x1fc0, 0x08 * sizeof(void *));
209         memcpy(psxMemRLUT + 0xbfc0, psxMemRLUT + 0x1fc0, 0x08 * sizeof(void *));
210
211 // MemW
212         for (i = 0; i < 0x80; i++) psxMemWLUT[i + 0x0000] = (u8 *)&psxM[(i & 0x1f) << 16];
213
214         memcpy(psxMemWLUT + 0x8000, psxMemWLUT, 0x80 * sizeof(void *));
215         memcpy(psxMemWLUT + 0xa000, psxMemWLUT, 0x80 * sizeof(void *));
216
217         // Don't allow writes to PIO Expansion region (psxP) to take effect.
218         // NOTE: Not sure if this is needed to fix any games but seems wise,
219         //       seeing as some games do read from PIO as part of copy-protection
220         //       check. (See fix in psxMemReset() regarding psxP region reads).
221         psxMemWLUT[0x1f00] = NULL;
222         psxMemWLUT[0x1f80] = (u8 *)psxH;
223
224         return 0;
225 }
226
227 void psxMemReset() {
228         FILE *f = NULL;
229         char bios[1024];
230
231         memset(psxM, 0, 0x00200000);
232         memset(psxP, 0xff, 0x00010000);
233
234         Config.HLE = TRUE;
235
236         if (strcmp(Config.Bios, "HLE") != 0) {
237                 sprintf(bios, "%s/%s", Config.BiosDir, Config.Bios);
238                 f = fopen(bios, "rb");
239
240                 if (f == NULL) {
241                         SysMessage(_("Could not open BIOS:\"%s\". Enabling HLE Bios!\n"), bios);
242                         memset(psxR, 0, 0x80000);
243                 } else {
244                         if (fread(psxR, 1, 0x80000, f) == 0x80000) {
245                                 Config.HLE = FALSE;
246                         } else {
247                                 SysMessage(_("The selected BIOS:\"%s\" is of wrong size. Enabling HLE Bios!\n"), bios);
248                         }
249                         fclose(f);
250                 }
251         }
252 }
253
254 void psxMemShutdown() {
255         psxUnmap(psxM, 0x00210000, MAP_TAG_RAM); psxM = NULL;
256         psxUnmap(psxH, 0x10000, MAP_TAG_OTHER); psxH = NULL;
257         psxUnmap(psxR, 0x80000, MAP_TAG_OTHER); psxR = NULL;
258
259         free(psxMemRLUT); psxMemRLUT = NULL;
260         free(psxMemWLUT); psxMemWLUT = NULL;
261 }
262
263 u8 psxMemRead8(u32 mem) {
264         char *p;
265         u32 t;
266
267         t = mem >> 16;
268         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
269                 if ((mem & 0xffff) < 0x400)
270                         return psxHu8(mem);
271                 else
272                         return psxHwRead8(mem);
273         } else {
274                 p = (char *)(psxMemRLUT[t]);
275                 if (p != NULL) {
276                         if (Config.Debug)
277                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, R1);
278                         return *(u8 *)(p + (mem & 0xffff));
279                 } else {
280 #ifdef PSXMEM_LOG
281                         PSXMEM_LOG("err lb %8.8lx\n", mem);
282 #endif
283                         return 0xFF;
284                 }
285         }
286 }
287
288 u16 psxMemRead16(u32 mem) {
289         char *p;
290         u32 t;
291
292         t = mem >> 16;
293         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
294                 if ((mem & 0xffff) < 0x400)
295                         return psxHu16(mem);
296                 else
297                         return psxHwRead16(mem);
298         } else {
299                 p = (char *)(psxMemRLUT[t]);
300                 if (p != NULL) {
301                         if (Config.Debug)
302                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, R2);
303                         return SWAPu16(*(u16 *)(p + (mem & 0xffff)));
304                 } else {
305 #ifdef PSXMEM_LOG
306                         PSXMEM_LOG("err lh %8.8lx\n", mem);
307 #endif
308                         return 0xFFFF;
309                 }
310         }
311 }
312
313 u32 psxMemRead32(u32 mem) {
314         char *p;
315         u32 t;
316
317         t = mem >> 16;
318         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
319                 if ((mem & 0xffff) < 0x400)
320                         return psxHu32(mem);
321                 else
322                         return psxHwRead32(mem);
323         } else {
324                 p = (char *)(psxMemRLUT[t]);
325                 if (p != NULL) {
326                         if (Config.Debug)
327                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, R4);
328                         return SWAPu32(*(u32 *)(p + (mem & 0xffff)));
329                 } else {
330 #ifdef PSXMEM_LOG
331                         if (writeok) { PSXMEM_LOG("err lw %8.8lx\n", mem); }
332 #endif
333                         return 0xFFFFFFFF;
334                 }
335         }
336 }
337
338 void psxMemWrite8(u32 mem, u8 value) {
339         char *p;
340         u32 t;
341
342         t = mem >> 16;
343         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
344                 if ((mem & 0xffff) < 0x400)
345                         psxHu8(mem) = value;
346                 else
347                         psxHwWrite8(mem, value);
348         } else {
349                 p = (char *)(psxMemWLUT[t]);
350                 if (p != NULL) {
351                         if (Config.Debug)
352                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, W1);
353                         *(u8 *)(p + (mem & 0xffff)) = value;
354 #ifdef PSXREC
355                         psxCpu->Clear((mem & (~3)), 1);
356 #endif
357                 } else {
358 #ifdef PSXMEM_LOG
359                         PSXMEM_LOG("err sb %8.8lx\n", mem);
360 #endif
361                 }
362         }
363 }
364
365 void psxMemWrite16(u32 mem, u16 value) {
366         char *p;
367         u32 t;
368
369         t = mem >> 16;
370         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
371                 if ((mem & 0xffff) < 0x400)
372                         psxHu16ref(mem) = SWAPu16(value);
373                 else
374                         psxHwWrite16(mem, value);
375         } else {
376                 p = (char *)(psxMemWLUT[t]);
377                 if (p != NULL) {
378                         if (Config.Debug)
379                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, W2);
380                         *(u16 *)(p + (mem & 0xffff)) = SWAPu16(value);
381 #ifdef PSXREC
382                         psxCpu->Clear((mem & (~3)), 1);
383 #endif
384                 } else {
385 #ifdef PSXMEM_LOG
386                         PSXMEM_LOG("err sh %8.8lx\n", mem);
387 #endif
388                 }
389         }
390 }
391
392 void psxMemWrite32(u32 mem, u32 value) {
393         char *p;
394 #if defined(ICACHE_EMULATION)
395         /*  Stores in PS1 code during cache isolation invalidate cachelines.
396          * It is assumed that cache-flush routines write to the lowest 4KB of
397          * address space for Icache, or 1KB for Dcache/scratchpad.
398          *  Originally, stores had to check 'writeok' in psxRegs struct before
399          * writing to RAM. To eliminate this necessity, we could simply patch the
400          * BIOS 0x44 FlushCache() A0 jumptable entry. Unfortunately, this won't
401          * work for some games that use less-buggy non-BIOS cache-flush routines
402          * like '007 Tomorrow Never Dies', often provided by SN-systems, the PS1
403          * toolchain provider.
404          *  Instead, we backup the lowest 64KB PS1 RAM when the cache is isolated.
405          * All stores write to RAM regardless of cache state. Thus, cache-flush
406          * routines temporarily trash the lowest 4KB of PS1 RAM. Fortunately, they
407          * ran in a 'critical section' with interrupts disabled, so there's little
408          * worry of PS1 code ever reading the trashed contents.
409          *  We point the relevant portions of psxMemRLUT[] to the 64KB backup while
410          * cache is isolated. This is in case the dynarec needs to recompile some
411          * code during isolation. As long as it reads code using psxMemRLUT[] ptrs,
412          * it should never see trashed RAM contents.
413          *
414          * -senquack, mips dynarec team, 2017
415          */
416         static u32 mem_bak[0x10000/4];
417 #endif
418         u32 t;
419         u32 m = mem & 0xffff;
420 //      if ((mem&0x1fffff) == 0x71E18 || value == 0x48088800) SysPrintf("t2fix!!\n");
421         t = mem >> 16;
422         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
423                 if (m < 0x400)
424                         psxHu32ref(mem) = SWAPu32(value);
425                 else
426                         psxHwWrite32(mem, value);
427         } else {
428                 p = (char *)(psxMemWLUT[t]);
429                 if (p != NULL) {
430                         if (Config.Debug)
431                                 DebugCheckBP((mem & 0xffffff) | 0x80000000, W4);
432                         *(u32 *)(p + (mem & 0xffff)) = SWAPu32(value);
433 #ifdef PSXREC
434                         psxCpu->Clear(mem, 1);
435 #endif
436                 } else {
437                         if (mem != 0xfffe0130) {
438 #ifdef PSXREC
439                                 if (!writeok)
440                                         psxCpu->Clear(mem, 1);
441 #endif
442
443 #ifdef PSXMEM_LOG
444                                 if (writeok) { PSXMEM_LOG("err sw %8.8lx\n", mem); }
445 #endif
446                         } else {
447                                 int i;
448
449                                 switch (value) {
450                                         case 0x800: case 0x804:
451                                                 if (writeok == FALSE) break;
452                                                 writeok = FALSE;
453                                                 memset(psxMemWLUT + 0x0000, 0, 0x80 * sizeof(void *));
454                                                 memset(psxMemWLUT + 0x8000, 0, 0x80 * sizeof(void *));
455                                                 memset(psxMemWLUT + 0xa000, 0, 0x80 * sizeof(void *));
456 #ifdef ICACHE_EMULATION
457                                                 /* Cache is now isolated, pending cache-flush sequence:
458                                                 *  Backup lower 64KB of PS1 RAM, adjust psxMemRLUT[].
459                                                 */
460                                                 memcpy((void*)mem_bak, (void*)psxM, sizeof(mem_bak));
461                                                 psxMemRLUT[0x0000] = psxMemRLUT[0x0020] = psxMemRLUT[0x0040] = psxMemRLUT[0x0060] = (u8 *)mem_bak;
462                                                 psxMemRLUT[0x8000] = psxMemRLUT[0x8020] = psxMemRLUT[0x8040] = psxMemRLUT[0x8060] = (u8 *)mem_bak;
463                                                 psxMemRLUT[0xa000] = psxMemRLUT[0xa020] = psxMemRLUT[0xa040] = psxMemRLUT[0xa060] = (u8 *)mem_bak;
464                                                 psxCpu->Notify(R3000ACPU_NOTIFY_CACHE_ISOLATED, NULL);
465 #endif
466                                                 break;
467                                         case 0x00: case 0x1e988:
468                                                 if (writeok == TRUE) break;
469                                                 writeok = TRUE;
470                                                 for (i = 0; i < 0x80; i++) psxMemWLUT[i + 0x0000] = (void *)&psxM[(i & 0x1f) << 16];
471                                                 memcpy(psxMemWLUT + 0x8000, psxMemWLUT, 0x80 * sizeof(void *));
472                                                 memcpy(psxMemWLUT + 0xa000, psxMemWLUT, 0x80 * sizeof(void *));
473 #ifdef ICACHE_EMULATION
474                                                 /* Cache is now unisolated:
475                                                 * Restore lower 64KB RAM contents and psxMemRLUT[].
476                                                 */
477                                                 memcpy((void*)psxM, (void*)mem_bak, sizeof(mem_bak));
478                                                 psxMemRLUT[0x0000] = psxMemRLUT[0x0020] = psxMemRLUT[0x0040] = psxMemRLUT[0x0060] = (u8 *)psxM;
479                                                 psxMemRLUT[0x8000] = psxMemRLUT[0x8020] = psxMemRLUT[0x8040] = psxMemRLUT[0x8060] = (u8 *)psxM;
480                                                 psxMemRLUT[0xa000] = psxMemRLUT[0xa020] = psxMemRLUT[0xa040] = psxMemRLUT[0xa060] = (u8 *)psxM;
481                                                 /* Dynarecs might take this opportunity to flush their code cache */
482                                                 psxCpu->Notify(R3000ACPU_NOTIFY_CACHE_UNISOLATED, NULL);
483 #endif
484                                                 break;
485                                         default:
486 #ifdef PSXMEM_LOG
487                                                 PSXMEM_LOG("unk %8.8lx = %x\n", mem, value);
488 #endif
489                                                 break;
490                                 }
491                         }
492                 }
493         }
494 }
495
496 void *psxMemPointer(u32 mem) {
497         char *p;
498         u32 t;
499
500         t = mem >> 16;
501         if (t == 0x1f80 || t == 0x9f80 || t == 0xbf80) {
502                 if ((mem & 0xffff) < 0x400)
503                         return (void *)&psxH[mem];
504                 else
505                         return NULL;
506         } else {
507                 p = (char *)(psxMemWLUT[t]);
508                 if (p != NULL) {
509                         return (void *)(p + (mem & 0xffff));
510                 }
511                 return NULL;
512         }
513 }