Nugget
patches.h
1 /*
2 
3 MIT License
4 
5 Copyright (c) 2021 PCSX-Redux authors
6 
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to deal
9 in the Software without restriction, including without limitation the rights
10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13 
14 The above copyright notice and this permission notice shall be included in all
15 copies or substantial portions of the Software.
16 
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 SOFTWARE.
24 
25 */
26 
27 #pragma once
28 
29 #include <stdint.h>
30 
31 /*
32  Most PSX games will have kernel patches within them. Most (but not all)
33  of these patches will call B0:56 and B0:57 to get the pointer of the
34  B0 and C0 tables. It will be close to impossible for us to create code
35  in a way that will make these patches work properly transparently, so
36  instead we will rely on the fact they are calling these two functions,
37  and then we patch them out after we detect them. This assumes that these
38  two functions aren't called for anything else but the patches. The
39  boolean below controls if we want to be permissive or not with unrecognized
40  patches. It is currently set to 1, and probably should remain so for a
41  long time, until we are sure we got all the patches properly.
42 
43  Then, depending on the patch itself, we may change our kernel's behavior,
44  in order to emulate what the original patch was trying to do.
45 */
46 
47 extern int g_patch_permissive;
48 
49 enum patch_table { PATCH_TABLE_B0, PATCH_TABLE_C0 };
50 void patch_hook(uint32_t* ra, enum patch_table table);
51 
52 enum patch_behavior { PATCH_NOT_MATCHING, PATCH_COUNTERPATCH, PATCH_PASSTHROUGH };