src/gba/serialize.h (view raw)
1/* Copyright (c) 2013-2016 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 "core/core.h"
12#include "gba/gba.h"
13
14extern const uint32_t GBA_SAVESTATE_MAGIC;
15extern const uint32_t GBA_SAVESTATE_VERSION;
16
17mLOG_DECLARE_CATEGORY(GBA_STATE);
18
19/* Savestate format:
20 * 0x00000 - 0x00003: Version Magic (0x01000001)
21 * 0x00004 - 0x00007: BIOS checksum (e.g. 0xBAAE187F for official BIOS)
22 * 0x00008 - 0x0000B: ROM CRC32
23 * 0x0000C - 0x0000F: Reserved (leave zero)
24 * 0x00010 - 0x0001B: Game title (e.g. METROID4USA)
25 * 0x0001C - 0x0001F: Game code (e.g. AMTE)
26 * 0x00020 - 0x0012F: CPU state:
27 * | 0x00020 - 0x0005F: GPRs
28 * | 0x00060 - 0x00063: CPSR
29 * | 0x00064 - 0x00067: SPSR
30 * | 0x00068 - 0x0006B: Cycles since last event
31 * | 0x0006C - 0x0006F: Cycles until next event
32 * | 0x00070 - 0x00117: Banked registers
33 * | 0x00118 - 0x0012F: Banked SPSRs
34 * 0x00130 - 0x00143: Audio channel 1/framer state
35 * | 0x00130 - 0x00133: Envelepe timing
36 * | bits 0 - 6: Remaining length
37 * | bits 7 - 9: Next step
38 * | bits 10 - 20: Shadow frequency register
39 * | bits 21 - 31: Reserved
40 * | 0x00134 - 0x00137: Next frame
41 * | 0x00138 - 0x0013F: Reserved
42 * | 0x00140 - 0x00143: Next event
43 * 0x00144 - 0x00153: Audio channel 2 state
44 * | 0x00144 - 0x00147: Envelepe timing
45 * | bits 0 - 2: Remaining length
46 * | bits 3 - 5: Next step
47 * | bits 6 - 31: Reserved
48 * | 0x00148 - 0x0014F: Reserved
49 * | 0x00150 - 0x00153: Next event
50 * 0x00154 - 0x0017B: Audio channel 3 state
51 * | 0x00154 - 0x00173: Wave banks
52 * | 0x00174 - 0x00175: Remaining length
53 * | 0x00176 - 0x00177: Reserved
54 * | 0x00178 - 0x0017B: Next event
55 * 0x0017C - 0x0018B: Audio channel 4 state
56 * | 0x0017C - 0x0017F: Linear feedback shift register state
57 * | 0x00180 - 0x00183: Envelepe timing
58 * | bits 0 - 2: Remaining length
59 * | bits 3 - 5: Next step
60 * | bits 6 - 31: Reserved
61 * | 0x00184 - 0x00187: Reserved
62 * | 0x00188 - 0x0018B: Next event
63 * 0x0018C - 0x001AB: Audio FIFO 1
64 * 0x001AC - 0x001CB: Audio FIFO 2
65 * 0x001CC - 0x001DF: Audio miscellaneous state
66 * | 0x001CC - 0x001CF: Next event
67 * | 0x001D0 - 0x001D3: Event diff
68 * | 0x001D4 - 0x001D7: Next sample
69 * | 0x001D8 - 0x001DB: FIFO size
70 * | TODO: Fix this, they're in big-endian order, but field is little-endian
71 * | 0x001DC - 0x001DC: Channel 1 envelope state
72 * | bits 0 - 3: Current volume
73 * | bit 4: Is dead?
74 * | bit 5: Is high?
75 * | bit 6: Is sweep enabled?
76 * | bit 7: Has sweep occurred?
77 * | 0x001DD - 0x001DD: Channel 2 envelope state
78 * | bits 0 - 3: Current volume
79 * | bit 4: Is dead?
80 * | bit 5: Is high?
81 * | bits 6 - 7: Reserved
82 * | 0x001DE - 0x001DE: Channel 4 envelope state
83 * | bits 0 - 3: Current volume
84 * | bit 4: Is dead?
85 * | bits 5 - 7: Reserved
86 * | 0x001DF - 0x001DF: Miscellaneous audio flags
87 * | bits 0 - 3: Current frame
88 * 0x001E0 - 0x001FF: Video miscellaneous state
89 * | 0x001E0 - 0x001E3: Next event
90 * | 0x001E4 - 0x001E7: Event diff
91 * | 0x001E8 - 0x001EB: Last hblank
92 * | 0x001EC - 0x001EF: Next hblank
93 * | 0x001F0 - 0x001F3: Next hblank IRQ
94 * | 0x001F4 - 0x001F7: Next vblank IRQ
95 * | 0x001F8 - 0x001FB: Next vcounter IRQ
96 * | 0x001FC - 0x001FF: Frame counter
97 * 0x00200 - 0x00213: Timer 0
98 * | 0x00200 - 0x00201: Reload value
99 * | 0x00202 - 0x00203: Old reload value
100 * | 0x00204 - 0x00207: Last event
101 * | 0x00208 - 0x0020B: Next event
102 * | 0x0020C - 0x0020F: Overflow interval
103 * | 0x00210 - 0x00213: Miscellaneous flags
104 * 0x00214 - 0x00227: Timer 1
105 * | 0x00214 - 0x00215: Reload value
106 * | 0x00216 - 0x00217: Old reload value
107 * | 0x00218 - 0x0021B: Last event
108 * | 0x0021C - 0x0021F: Next event
109 * | 0x00220 - 0x00223: Overflow interval
110 * | 0x00224 - 0x00227: Miscellaneous flags
111 * 0x00228 - 0x0023B: Timer 2
112 * | 0x00228 - 0x00229: Reload value
113 * | 0x0022A - 0x0022B: Old reload value
114 * | 0x0022C - 0x0022F: Last event
115 * | 0x00230 - 0x00233: Next event
116 * | 0x00234 - 0x00237: Overflow interval
117 * | 0x00238 - 0x0023B: Miscellaneous flags
118 * 0x0023C - 0x00250: Timer 3
119 * | 0x0023C - 0x0023D: Reload value
120 * | 0x0023E - 0x0023F: Old reload value
121 * | 0x00240 - 0x00243: Last event
122 * | 0x00244 - 0x00247: Next event
123 * | 0x00248 - 0x0024B: Overflow interval
124 * | 0x0024C - 0x0024F: Miscellaneous flags
125 * 0x00250 - 0x0025F: DMA 0
126 * | 0x00250 - 0x00253: DMA next source
127 * | 0x00254 - 0x00257: DMA next destination
128 * | 0x00258 - 0x0025B: DMA next count
129 * | 0x0025C - 0x0025F: DMA next event
130 * 0x00260 - 0x0026F: DMA 1
131 * | 0x00260 - 0x00263: DMA next source
132 * | 0x00264 - 0x00267: DMA next destination
133 * | 0x00268 - 0x0026B: DMA next count
134 * | 0x0026C - 0x0026F: DMA next event
135 * 0x00270 - 0x0027F: DMA 2
136 * | 0x00270 - 0x00273: DMA next source
137 * | 0x00274 - 0x00277: DMA next destination
138 * | 0x00278 - 0x0027B: DMA next count
139 * | 0x0027C - 0x0027F: DMA next event
140 * 0x00280 - 0x0028F: DMA 3
141 * | 0x00280 - 0x00283: DMA next source
142 * | 0x00284 - 0x00287: DMA next destination
143 * | 0x00288 - 0x0028B: DMA next count
144 * | 0x0028C - 0x0028F: DMA next event
145 * 0x00290 - 0x002C3: GPIO state
146 * | 0x00290 - 0x00291: Pin state
147 * | 0x00292 - 0x00293: Direction state
148 * | 0x00294 - 0x002B6: RTC state (see hardware.h for format)
149 * | 0x002B7 - 0x002B7: GPIO devices
150 * | bit 0: Has RTC values
151 * | bit 1: Has rumble value (reserved)
152 * | bit 2: Has light sensor value
153 * | bit 3: Has gyroscope value
154 * | bit 4: Has tilt values
155 * | bit 5: Has Game Boy Player attached
156 * | bits 6 - 7: Reserved
157 * | 0x002B8 - 0x002B9: Gyroscope sample
158 * | 0x002BA - 0x002BB: Tilt x sample
159 * | 0x002BC - 0x002BD: Tilt y sample
160 * | 0x002BE - 0x002BF: Flags
161 * | bit 0: Is read enabled
162 * | bit 1: Gyroscope sample is edge
163 * | bit 2: Light sample is edge
164 * | bit 3: Reserved
165 * | bits 4 - 15: Light counter
166 * | 0x002C0 - 0x002C0: Light sample
167 * | 0x002C1 - 0x002C3: Flags
168 * | bits 0 - 1: Tilt state machine
169 * | bits 2 - 3: GB Player inputs posted
170 * | bits 4 - 8: GB Player transmit position
171 * | bits 9 - 23: Reserved
172 * 0x002C4 - 0x002C7: Game Boy Player next event
173 * 0x002C8 - 0x002DF: Reserved (leave zero)
174 * 0x002E0 - 0x002EF: Savedata state
175 * | 0x002E0 - 0x002E0: Savedata type
176 * | 0x002E1 - 0x002E1: Savedata command (see savedata.h)
177 * | 0x002E2 - 0x002E2: Flags
178 * | bits 0 - 1: Flash state machine
179 * | bits 2 - 3: Reserved
180 * | bit 4: Flash bank
181 * | bits 5 - 7: Reserved
182 * | 0x002E3 - 0x002E3: Reserved
183 * | 0x002E4 - 0x002E7: EEPROM read bits remaining
184 * | 0x002E8 - 0x002EB: EEPROM read address
185 * | 0x002EC - 0x002EF: EEPROM write address
186 * | 0x002F0 - 0x002F1: Flash settling sector
187 * | 0x002F2 - 0x002F3: Flash settling remaining
188 * 0x002F4 - 0x002FF: Prefetch
189 * | 0x002F4 - 0x002F7: GBA BIOS bus prefetch
190 * | 0x002F8 - 0x002FB: CPU prefecth (decode slot)
191 * | 0x002FC - 0x002FF: CPU prefetch (fetch slot)
192 * 0x00300 - 0x00303: Associated movie stream ID for record/replay (or 0 if no stream)
193 * 0x00304 - 0x0030F: Reserved (leave zero)
194 * 0x00310 - 0x00317: Savestate creation time (usec since 1970)
195 * 0x00318 - 0x003FF: Reserved (leave zero)
196 * 0x00400 - 0x007FF: I/O memory
197 * 0x00800 - 0x00BFF: Palette
198 * 0x00C00 - 0x00FFF: OAM
199 * 0x01000 - 0x18FFF: VRAM
200 * 0x19000 - 0x20FFF: IWRAM
201 * 0x21000 - 0x60FFF: WRAM
202 * Total size: 0x61000 (397,312) bytes
203 */
204
205DECL_BITFIELD(GBASerializedAudioFlags, uint32_t);
206DECL_BITS(GBASerializedAudioFlags, Ch1Volume, 0, 4);
207DECL_BIT(GBASerializedAudioFlags, Ch1Dead, 4);
208DECL_BIT(GBASerializedAudioFlags, Ch1Hi, 5);
209DECL_BIT(GBASerializedAudioFlags, Ch1SweepEnabled, 6);
210DECL_BIT(GBASerializedAudioFlags, Ch1SweepOccurred, 7);
211DECL_BITS(GBASerializedAudioFlags, Ch2Volume, 8, 4);
212DECL_BIT(GBASerializedAudioFlags, Ch2Dead, 12);
213DECL_BIT(GBASerializedAudioFlags, Ch2Hi, 13);
214DECL_BITS(GBASerializedAudioFlags, Ch4Volume, 16, 4);
215DECL_BIT(GBASerializedAudioFlags, Ch4Dead, 20);
216DECL_BITS(GBASerializedAudioFlags, Frame, 21, 3);
217
218DECL_BITFIELD(GBASerializedAudioEnvelope, uint32_t);
219DECL_BITS(GBASerializedAudioEnvelope, Length, 0, 7);
220DECL_BITS(GBASerializedAudioEnvelope, NextStep, 7, 3);
221DECL_BITS(GBASerializedAudioEnvelope, Frequency, 10, 11);
222
223DECL_BITFIELD(GBASerializedHWFlags1, uint16_t);
224DECL_BIT(GBASerializedHWFlags1, ReadWrite, 0);
225DECL_BIT(GBASerializedHWFlags1, GyroEdge, 1);
226DECL_BIT(GBASerializedHWFlags1, LightEdge, 2);
227DECL_BITS(GBASerializedHWFlags1, LightCounter, 4, 12);
228
229DECL_BITFIELD(GBASerializedHWFlags2, uint8_t);
230DECL_BITS(GBASerializedHWFlags2, TiltState, 0, 2);
231DECL_BITS(GBASerializedHWFlags2, GbpInputsPosted, 2, 2);
232DECL_BITS(GBASerializedHWFlags2, GbpTxPosition, 4, 5);
233
234DECL_BITFIELD(GBASerializedHWFlags3, uint16_t);
235
236DECL_BITFIELD(GBASerializedSavedataFlags, uint8_t);
237DECL_BITS(GBASerializedSavedataFlags, FlashState, 0, 2);
238DECL_BIT(GBASerializedSavedataFlags, FlashBank, 4);
239
240struct GBASerializedState {
241 uint32_t versionMagic;
242 uint32_t biosChecksum;
243 uint32_t romCrc32;
244 uint32_t reservedHeader;
245
246 char title[12];
247 uint32_t id;
248
249 struct {
250 int32_t gprs[16];
251 union PSR cpsr;
252 union PSR spsr;
253
254 int32_t cycles;
255 int32_t nextEvent;
256
257 int32_t bankedRegisters[6][7];
258 int32_t bankedSPSRs[6];
259 } cpu;
260
261 struct {
262 struct {
263 GBASerializedAudioEnvelope envelope;
264 int32_t nextFrame;
265 int32_t reserved[2];
266 int32_t nextEvent;
267 } ch1;
268 struct {
269 GBASerializedAudioEnvelope envelope;
270 int32_t reserved[2];
271 int32_t nextEvent;
272 } ch2;
273 struct {
274 uint32_t wavebanks[8];
275 int16_t length;
276 int16_t reserved;
277 int32_t nextEvent;
278 } ch3;
279 struct {
280 int32_t lfsr;
281 GBASerializedAudioEnvelope envelope;
282 int32_t reserved;
283 int32_t nextEvent;
284 } ch4;
285 uint8_t fifoA[32];
286 uint8_t fifoB[32];
287 int32_t nextEvent;
288 int32_t eventDiff;
289 int32_t nextSample;
290 uint32_t fifoSize;
291 GBASerializedAudioFlags flags;
292 } audio;
293
294 struct {
295 int32_t nextEvent;
296 int32_t eventDiff;
297 int32_t lastHblank;
298 int32_t nextHblank;
299 int32_t nextHblankIRQ;
300 int32_t nextVblankIRQ;
301 int32_t nextVcounterIRQ;
302 int32_t frameCounter;
303 } video;
304
305 struct GBATimer timers[4];
306
307 struct {
308 uint32_t nextSource;
309 uint32_t nextDest;
310 int32_t nextCount;
311 int32_t nextEvent;
312 } dma[4];
313
314 struct {
315 uint16_t pinState;
316 uint16_t pinDirection;
317 struct GBARTC rtc;
318 uint8_t devices;
319 uint16_t gyroSample;
320 uint16_t tiltSampleX;
321 uint16_t tiltSampleY;
322 GBASerializedHWFlags1 flags1;
323 uint8_t lightSample;
324 GBASerializedHWFlags2 flags2;
325 GBASerializedHWFlags3 flags3;
326 uint32_t gbpNextEvent;
327 } hw;
328
329 uint32_t reservedHardware[6];
330
331 struct {
332 uint8_t type;
333 uint8_t command;
334 GBASerializedSavedataFlags flags;
335 uint8_t reserved;
336 int32_t readBitsRemaining;
337 uint32_t readAddress;
338 uint32_t writeAddress;
339 uint16_t settlingSector;
340 uint16_t settlingDust;
341 } savedata;
342
343 uint32_t biosPrefetch;
344 uint32_t cpuPrefetch[2];
345
346 uint32_t associatedStreamId;
347 uint32_t reservedRr[3];
348
349 uint64_t creationUsec;
350
351 uint32_t reserved[58];
352
353 uint16_t io[SIZE_IO >> 1];
354 uint16_t pram[SIZE_PALETTE_RAM >> 1];
355 uint16_t oam[SIZE_OAM >> 1];
356 uint16_t vram[SIZE_VRAM >> 1];
357 uint8_t iwram[SIZE_WORKING_IRAM];
358 uint8_t wram[SIZE_WORKING_RAM];
359};
360
361enum GBAExtdataTag {
362 EXTDATA_NONE = 0,
363 EXTDATA_SCREENSHOT = 1,
364 EXTDATA_SAVEDATA = 2,
365 EXTDATA_CHEATS = 3,
366 EXTDATA_MAX
367};
368
369#define SAVESTATE_SCREENSHOT 1
370#define SAVESTATE_SAVEDATA 2
371#define SAVESTATE_CHEATS 4
372
373struct GBAExtdataItem {
374 int32_t size;
375 void* data;
376 void (*clean)(void*);
377};
378
379struct GBAExtdata {
380 struct GBAExtdataItem data[EXTDATA_MAX];
381};
382
383struct VDir;
384
385void GBASerialize(struct GBA* gba, struct GBASerializedState* state);
386bool GBADeserialize(struct GBA* gba, const struct GBASerializedState* state);
387
388bool GBASaveStateNamed(struct GBA* gba, struct VFile* vf, int flags);
389bool GBALoadStateNamed(struct GBA* gba, struct VFile* vf, int flags);
390
391bool GBAExtdataInit(struct GBAExtdata*);
392void GBAExtdataDeinit(struct GBAExtdata*);
393void GBAExtdataPut(struct GBAExtdata*, enum GBAExtdataTag, struct GBAExtdataItem*);
394bool GBAExtdataGet(struct GBAExtdata*, enum GBAExtdataTag, struct GBAExtdataItem*);
395bool GBAExtdataSerialize(struct GBAExtdata* extpdata, struct VFile* vf);
396bool GBAExtdataDeserialize(struct GBAExtdata* extdata, struct VFile* vf);
397
398struct GBASerializedState* GBAExtractState(struct VFile* vf, struct GBAExtdata* extdata);
399struct GBASerializedState* GBAAllocateState(void);
400void GBADeallocateState(struct GBASerializedState* state);
401
402#endif