1/* Copyright (c) 2013-2014 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.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: Reserved
 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 - 0x002BF: GPIO state
130 * | 0x00290 - 0x00291: Pin state
131 * | 0x00292 - 0x00293: Direction state
132 * | 0x00294 - 0x002B6: RTC state (see gba-gpio.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 (reserved)
137 *   | bit 3: Has gyroscope value
138 *   | bit 4: Has tilt values (reserved)
139 *   | bits 5 - 7: Reserved
140 * | 0x002B8 - 0x002B9: Gyroscope sample
141 * | 0x002BA - 0x002BB: Tilt x sample (reserved)
142 * | 0x002BC - 0x002BD: Tilt y sample (reserved)
143 * | 0x002BE - 0x002BF: Flags
144 *   | bit 0: Is read enabled
145 *   | bit 1: Gyroscope sample is edge
146 *   | bits 2 - 15: Reserved
147 * 0x002C0 - 0x002FF: Reserved (leave zero)
148 * 0x00300 - 0x00303: Associated movie stream ID for record/replay (or 0 if no stream)
149 * 0x00304 - 0x003FF: Reserved (leave zero)
150 * 0x00400 - 0x007FF: I/O memory
151 * 0x00800 - 0x00BFF: Palette
152 * 0x00C00 - 0x00FFF: OAM
153 * 0x01000 - 0x18FFF: VRAM
154 * 0x19000 - 0x20FFF: IWRAM
155 * 0x21000 - 0x60FFF: WRAM
156 * Total size: 0x61000 (397,312) bytes
157 */
158
159struct GBASerializedState {
160	uint32_t versionMagic;
161	uint32_t biosChecksum;
162	uint32_t romCrc32;
163	uint32_t reservedHeader;
164
165	char title[12];
166	uint32_t id;
167
168	struct {
169		int32_t gprs[16];
170		union PSR cpsr;
171		union PSR spsr;
172
173		int32_t cycles;
174		int32_t nextEvent;
175
176		int32_t bankedRegisters[6][7];
177		int32_t bankedSPSRs[6];
178	} cpu;
179
180	struct {
181		struct {
182			int32_t envelopeNextStep;
183			int32_t waveNextStep;
184			int32_t sweepNextStep;
185			int32_t endTime;
186			int32_t nextEvent;
187		} ch1;
188		struct {
189			int32_t envelopeNextStep;
190			int32_t waveNextStep;
191			int32_t endTime;
192			int32_t nextEvent;
193		} ch2;
194		struct {
195			uint32_t wavebanks[8];
196			int32_t endTime;
197			int32_t nextEvent;
198		} ch3;
199		struct {
200			int32_t lfsr;
201			int32_t envelopeNextStep;
202			int32_t endTime;
203			int32_t nextEvent;
204		} ch4;
205		uint8_t fifoA[32];
206		uint8_t fifoB[32];
207		int32_t nextEvent;
208		int32_t eventDiff;
209		int32_t nextSample;
210		int32_t fifoSize;
211		unsigned ch1Volume : 4;
212		unsigned ch1Dead : 1;
213		unsigned ch1Hi : 1;
214		unsigned : 2;
215		unsigned ch2Volume : 4;
216		unsigned ch2Dead : 1;
217		unsigned ch2Hi : 1;
218		unsigned : 2;
219		unsigned ch4Volume : 4;
220		unsigned ch4Dead : 1;
221		unsigned : 3;
222		unsigned : 8;
223	} audio;
224
225	struct {
226		int32_t nextEvent;
227		int32_t eventDiff;
228		int32_t lastHblank;
229		int32_t nextHblank;
230		int32_t nextHblankIRQ;
231		int32_t nextVblankIRQ;
232		int32_t nextVcounterIRQ;
233		int32_t : 32;
234	} video;
235
236	struct GBATimer timers[4];
237
238	struct {
239		uint32_t nextSource;
240		uint32_t nextDest;
241		int32_t nextCount;
242		int32_t nextEvent;
243	} dma[4];
244
245	struct {
246		uint16_t pinState;
247		uint16_t pinDirection;
248		struct GBARTC rtc;
249		uint8_t devices;
250		unsigned gyroSample : 16;
251		unsigned tiltSampleX : 16;
252		unsigned tiltSampleY : 16;
253		unsigned readWrite : 1;
254		unsigned gyroEdge : 1;
255		unsigned reserved : 14;
256	} gpio;
257
258	uint32_t reservedGpio[16];
259
260	uint32_t associatedStreamId;
261
262	uint32_t reserved[63];
263
264	uint16_t io[SIZE_IO >> 1];
265	uint16_t pram[SIZE_PALETTE_RAM >> 1];
266	uint16_t oam[SIZE_OAM >> 1];
267	uint16_t vram[SIZE_VRAM >> 1];
268	uint8_t iwram[SIZE_WORKING_IRAM];
269	uint8_t wram[SIZE_WORKING_RAM];
270};
271
272struct VDir;
273
274void GBASerialize(struct GBA* gba, struct GBASerializedState* state);
275void GBADeserialize(struct GBA* gba, struct GBASerializedState* state);
276
277bool GBASaveState(struct GBA* gba, struct VDir* dir, int slot, bool screenshot);
278bool GBALoadState(struct GBA* gba, struct VDir* dir, int slot);
279struct VFile* GBAGetState(struct GBA* gba, struct VDir* dir, int slot, bool write);
280
281bool GBASaveStateNamed(struct GBA* gba, struct VFile* vf, bool screenshot);
282bool GBALoadStateNamed(struct GBA* gba, struct VFile* vf);
283
284struct GBASerializedState* GBAAllocateState(void);
285void GBADeallocateState(struct GBASerializedState* state);
286
287struct GBAThread;
288void GBARecordFrame(struct GBAThread* thread);
289void GBARewind(struct GBAThread* thread, int nStates);
290
291#endif