src/gba/serialize.h (view raw)
1/* Copyright (c) 2013-2015 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#ifndef GBA_SERIALIZE_H
7#define GBA_SERIALIZE_H
8
9#include "util/common.h"
10
11#include "gba/gba.h"
12
13extern const uint32_t GBA_SAVESTATE_MAGIC;
14
15/* Savestate format:
16 * 0x00000 - 0x00003: Version Magic (0x01000000)
17 * 0x00004 - 0x00007: BIOS checksum (e.g. 0xBAAE187F for official BIOS)
18 * 0x00008 - 0x0000B: ROM CRC32
19 * 0x0000C - 0x0000F: Reserved (leave zero)
20 * 0x00010 - 0x0001B: Game title (e.g. METROID4USA)
21 * 0x0001C - 0x0001F: Game code (e.g. AMTE)
22 * 0x00020 - 0x0012F: CPU state:
23 * | 0x00020 - 0x0005F: GPRs
24 * | 0x00060 - 0x00063: CPSR
25 * | 0x00064 - 0x00067: SPSR
26 * | 0x00068 - 0x0006B: Cycles since last event
27 * | 0x0006C - 0x0006F: Cycles until next event
28 * | 0x00070 - 0x00117: Banked registers
29 * | 0x00118 - 0x0012F: Banked SPSRs
30 * 0x00130 - 0x00143: Audio channel 1 state
31 * | 0x00130 - 0x00133: Next envelope step
32 * | 0x00134 - 0x00137: Next square wave step
33 * | 0x00138 - 0x0013B: Next sweep step
34 * | 0x0013C - 0x0013F: Channel end cycle
35 * | 0x00140 - 0x00143: Next event
36 * 0x00144 - 0x00153: Audio channel 2 state
37 * | 0x00144 - 0x00147: Next envelope step
38 * | 0x00148 - 0x0014B: Next square wave step
39 * | 0x0014C - 0x0014F: Channel end cycle
40 * | 0x00150 - 0x00153: Next event
41 * 0x00154 - 0x0017B: Audio channel 3 state
42 * | 0x00154 - 0x00173: Wave banks
43 * | 0x00174 - 0x00177: Channel end cycle
44 * | 0x00178 - 0x0017B: Next event
45 * 0x0017C - 0x0018B: Audio channel 4 state
46 * | 0x0017C - 0x0017F: Linear feedback shift register state
47 * | 0x00180 - 0x00183: Next enveleope step
48 * | 0x00184 - 0x00187: Channel end cycle
49 * | 0x00188 - 0x0018B: Next event
50 * 0x0018C - 0x001AB: Audio FIFO 1
51 * 0x001AC - 0x001CB: Audio FIFO 2
52 * 0x001CC - 0x001DF: Audio miscellaneous state
53 * | 0x001CC - 0x001CF: Next event
54 * | 0x001D0 - 0x001D3: Event diff
55 * | 0x001D4 - 0x001D7: Next sample
56 * | 0x001D8 - 0x001DB: FIFO size
57 * | 0x001DC - 0x001DC: Channel 1 envelope state
58 * | bits 0 - 3: Current volume
59 * | bit 4: Is dead?
60 * | bit 5: Is high?
61 * | bits 6 - 7: Reserved
62 * | 0x001DD - 0x001DD: Channel 2 envelope state
63 * | bits 0 - 3: Current volume
64 * | bit 4: Is dead?
65 * | bit 5: Is high?
66 * | bits 6 - 7: Reserved
67 * | 0x001DE - 0x001DE: Channel 4 envelope state
68 * | bits 0 - 3: Current volume
69 * | bit 4: Is dead?
70 * | bits 5 - 7: Reserved
71 * | 0x001DF - 0x001DF: Reserved
72 * 0x001E0 - 0x001FF: Video miscellaneous state
73 * | 0x001E0 - 0x001E3: Next event
74 * | 0x001E4 - 0x001E7: Event diff
75 * | 0x001E8 - 0x001EB: Last hblank
76 * | 0x001EC - 0x001EF: Next hblank
77 * | 0x001F0 - 0x001F3: Next hblank IRQ
78 * | 0x001F4 - 0x001F7: Next vblank IRQ
79 * | 0x001F8 - 0x001FB: Next vcounter IRQ
80 * | 0x001FC - 0x001FF: Frame counter
81 * 0x00200 - 0x00213: Timer 0
82 * | 0x00200 - 0x00201: Reload value
83 * | 0x00202 - 0x00203: Old reload value
84 * | 0x00204 - 0x00207: Last event
85 * | 0x00208 - 0x0020B: Next event
86 * | 0x0020C - 0x0020F: Overflow interval
87 * | 0x00210 - 0x00213: Miscellaneous flags
88 * 0x00214 - 0x00227: Timer 1
89 * | 0x00214 - 0x00215: Reload value
90 * | 0x00216 - 0x00217: Old reload value
91 * | 0x00218 - 0x0021B: Last event
92 * | 0x0021C - 0x0021F: Next event
93 * | 0x00220 - 0x00223: Overflow interval
94 * | 0x00224 - 0x00227: Miscellaneous flags
95 * 0x00228 - 0x0023B: Timer 2
96 * | 0x00228 - 0x00229: Reload value
97 * | 0x0022A - 0x0022B: Old reload value
98 * | 0x0022C - 0x0022F: Last event
99 * | 0x00230 - 0x00233: Next event
100 * | 0x00234 - 0x00237: Overflow interval
101 * | 0x00238 - 0x0023B: Miscellaneous flags
102 * 0x0023C - 0x00250: Timer 3
103 * | 0x0023C - 0x0023D: Reload value
104 * | 0x0023E - 0x0023F: Old reload value
105 * | 0x00240 - 0x00243: Last event
106 * | 0x00244 - 0x00247: Next event
107 * | 0x00248 - 0x0024B: Overflow interval
108 * | 0x0024C - 0x0024F: Miscellaneous flags
109 * 0x00250 - 0x0025F: DMA 0
110 * | 0x00250 - 0x00253: DMA next source
111 * | 0x00254 - 0x00257: DMA next destination
112 * | 0x00258 - 0x0025B: DMA next count
113 * | 0x0025C - 0x0025F: DMA next event
114 * 0x00260 - 0x0026F: DMA 1
115 * | 0x00260 - 0x00263: DMA next source
116 * | 0x00264 - 0x00267: DMA next destination
117 * | 0x00268 - 0x0026B: DMA next count
118 * | 0x0026C - 0x0026F: DMA next event
119 * 0x00270 - 0x0027F: DMA 2
120 * | 0x00270 - 0x00273: DMA next source
121 * | 0x00274 - 0x00277: DMA next destination
122 * | 0x00278 - 0x0027B: DMA next count
123 * | 0x0027C - 0x0027F: DMA next event
124 * 0x00280 - 0x0028F: DMA 3
125 * | 0x00280 - 0x00283: DMA next source
126 * | 0x00284 - 0x00287: DMA next destination
127 * | 0x00288 - 0x0028B: DMA next count
128 * | 0x0028C - 0x0028F: DMA next event
129 * 0x00290 - 0x002C3: GPIO state
130 * | 0x00290 - 0x00291: Pin state
131 * | 0x00292 - 0x00293: Direction state
132 * | 0x00294 - 0x002B6: RTC state (see hardware.h for format)
133 * | 0x002B7 - 0x002B7: GPIO devices
134 * | bit 0: Has RTC values
135 * | bit 1: Has rumble value (reserved)
136 * | bit 2: Has light sensor value
137 * | bit 3: Has gyroscope value
138 * | bit 4: Has tilt values
139 * | bits 5 - 7: Reserved
140 * | 0x002B8 - 0x002B9: Gyroscope sample
141 * | 0x002BA - 0x002BB: Tilt x sample
142 * | 0x002BC - 0x002BD: Tilt y sample
143 * | 0x002BE - 0x002BF: Flags
144 * | bit 0: Is read enabled
145 * | bit 1: Gyroscope sample is edge
146 * | bit 2: Light sample is edge
147 * | bit 3: Reserved
148 * | bits 4 - 15: Light counter
149 * | 0x002C0 - 0x002C0: Light sample
150 * | 0x002C1 - 0x002C3: Flags
151 * | bits 0 - 1: Tilt state machine
152 * | bits 2 - 31: Reserved
153 * 0x002C4 - 0x002DF: Reserved (leave zero)
154 * 0x002E0 - 0x002EF: Savedata state
155 * | 0x002E0 - 0x002E0: Savedata type
156 * | 0x002E1 - 0x002E1: Savedata command (see savedata.h)
157 * | 0x002E2 - 0x002E2: Flags
158 * | bits 0 - 1: Flash state machine
159 * | bits 2 - 3: Reserved
160 * | bit 4: Flash bank
161 * | bits 5 - 7: Reserved
162 * | 0x002E3 - 0x002E3: Reserved
163 * | 0x002E4 - 0x002E7: EEPROM read bits remaining
164 * | 0x002E8 - 0x002EB: EEPROM read address
165 * | 0x002EC - 0x002EF: EEPROM write address
166 * | 0x002F0 - 0x002F1: Flash settling sector
167 * | 0x002F2 - 0x002F3: Flash settling remaining
168 * 0x002F4 - 0x002FF: Prefetch
169 * | 0x002F4 - 0x002F7: GBA BIOS bus prefetch
170 * | 0x002F8 - 0x002FB: CPU prefecth (decode slot)
171 * | 0x002FC - 0x002FF: CPU prefetch (fetch slot)
172 * 0x00300 - 0x00303: Associated movie stream ID for record/replay (or 0 if no stream)
173 * 0x00304 - 0x003FF: Reserved (leave zero)
174 * 0x00400 - 0x007FF: I/O memory
175 * 0x00800 - 0x00BFF: Palette
176 * 0x00C00 - 0x00FFF: OAM
177 * 0x01000 - 0x18FFF: VRAM
178 * 0x19000 - 0x20FFF: IWRAM
179 * 0x21000 - 0x60FFF: WRAM
180 * Total size: 0x61000 (397,312) bytes
181 */
182
183struct GBASerializedState {
184 uint32_t versionMagic;
185 uint32_t biosChecksum;
186 uint32_t romCrc32;
187 uint32_t reservedHeader;
188
189 char title[12];
190 uint32_t id;
191
192 struct {
193 int32_t gprs[16];
194 union PSR cpsr;
195 union PSR spsr;
196
197 int32_t cycles;
198 int32_t nextEvent;
199
200 int32_t bankedRegisters[6][7];
201 int32_t bankedSPSRs[6];
202 } cpu;
203
204 struct {
205 struct {
206 int32_t envelopeNextStep;
207 int32_t waveNextStep;
208 int32_t sweepNextStep;
209 int32_t endTime;
210 int32_t nextEvent;
211 } ch1;
212 struct {
213 int32_t envelopeNextStep;
214 int32_t waveNextStep;
215 int32_t endTime;
216 int32_t nextEvent;
217 } ch2;
218 struct {
219 uint32_t wavebanks[8];
220 int32_t endTime;
221 int32_t nextEvent;
222 } ch3;
223 struct {
224 int32_t lfsr;
225 int32_t envelopeNextStep;
226 int32_t endTime;
227 int32_t nextEvent;
228 } ch4;
229 uint8_t fifoA[32];
230 uint8_t fifoB[32];
231 int32_t nextEvent;
232 int32_t eventDiff;
233 int32_t nextSample;
234 int32_t fifoSize;
235 unsigned ch1Volume : 4;
236 unsigned ch1Dead : 1;
237 unsigned ch1Hi : 1;
238 unsigned : 2;
239 unsigned ch2Volume : 4;
240 unsigned ch2Dead : 1;
241 unsigned ch2Hi : 1;
242 unsigned : 2;
243 unsigned ch4Volume : 4;
244 unsigned ch4Dead : 1;
245 unsigned : 3;
246 unsigned : 8;
247 } audio;
248
249 struct {
250 int32_t nextEvent;
251 int32_t eventDiff;
252 int32_t lastHblank;
253 int32_t nextHblank;
254 int32_t nextHblankIRQ;
255 int32_t nextVblankIRQ;
256 int32_t nextVcounterIRQ;
257 int32_t frameCounter;
258 } video;
259
260 struct GBATimer timers[4];
261
262 struct {
263 uint32_t nextSource;
264 uint32_t nextDest;
265 int32_t nextCount;
266 int32_t nextEvent;
267 } dma[4];
268
269 struct {
270 uint16_t pinState;
271 uint16_t pinDirection;
272 struct GBARTC rtc;
273 uint8_t devices;
274 // Do not change these to uint16_t, this breaks bincompat with some older compilers
275 unsigned gyroSample : 16;
276 unsigned tiltSampleX : 16;
277 unsigned tiltSampleY : 16;
278 unsigned readWrite : 1;
279 unsigned gyroEdge : 1;
280 unsigned lightEdge : 1;
281 unsigned : 1;
282 unsigned lightCounter : 12;
283 unsigned lightSample : 8;
284 unsigned tiltState : 2;
285 unsigned : 22;
286 } hw;
287
288 uint32_t reservedHardware[7];
289
290 struct {
291 unsigned type : 8;
292 unsigned command : 8;
293 unsigned flashState : 2;
294 unsigned : 2;
295 unsigned flashBank : 1;
296 unsigned : 3;
297 unsigned : 8;
298 int32_t readBitsRemaining;
299 uint32_t readAddress;
300 uint32_t writeAddress;
301 uint16_t settlingSector;
302 uint16_t settlingDust;
303 } savedata;
304
305 uint32_t biosPrefetch;
306 uint32_t cpuPrefetch[2];
307
308 uint32_t associatedStreamId;
309
310 uint32_t reserved[63];
311
312 uint16_t io[SIZE_IO >> 1];
313 uint16_t pram[SIZE_PALETTE_RAM >> 1];
314 uint16_t oam[SIZE_OAM >> 1];
315 uint16_t vram[SIZE_VRAM >> 1];
316 uint8_t iwram[SIZE_WORKING_IRAM];
317 uint8_t wram[SIZE_WORKING_RAM];
318};
319
320struct VDir;
321struct GBAThread;
322
323void GBASerialize(struct GBA* gba, struct GBASerializedState* state);
324void GBADeserialize(struct GBA* gba, const struct GBASerializedState* state);
325
326bool GBASaveState(struct GBAThread* thread, struct VDir* dir, int slot, bool screenshot);
327bool GBALoadState(struct GBAThread* thread, struct VDir* dir, int slot);
328struct VFile* GBAGetState(struct GBA* gba, struct VDir* dir, int slot, bool write);
329
330bool GBASaveStateNamed(struct GBA* gba, struct VFile* vf, bool screenshot);
331bool GBALoadStateNamed(struct GBA* gba, struct VFile* vf);
332
333struct GBASerializedState* GBAAllocateState(void);
334void GBADeallocateState(struct GBASerializedState* state);
335
336void GBARecordFrame(struct GBAThread* thread);
337void GBARewindSettingsChanged(struct GBAThread* thread, int newCapacity, int newInterval);
338void GBARewind(struct GBAThread* thread, int nStates);
339void GBARewindAll(struct GBAThread* thread);
340
341#endif