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