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_H
  7#define GBA_H
  8
  9#include "util/common.h"
 10
 11#include "arm.h"
 12#include "debugger/debugger.h"
 13
 14#include "gba-memory.h"
 15#include "gba-video.h"
 16#include "gba-audio.h"
 17#include "gba-sio.h"
 18
 19extern const uint32_t GBA_ARM7TDMI_FREQUENCY;
 20
 21enum GBAIRQ {
 22	IRQ_VBLANK = 0x0,
 23	IRQ_HBLANK = 0x1,
 24	IRQ_VCOUNTER = 0x2,
 25	IRQ_TIMER0 = 0x3,
 26	IRQ_TIMER1 = 0x4,
 27	IRQ_TIMER2 = 0x5,
 28	IRQ_TIMER3 = 0x6,
 29	IRQ_SIO = 0x7,
 30	IRQ_DMA0 = 0x8,
 31	IRQ_DMA1 = 0x9,
 32	IRQ_DMA2 = 0xA,
 33	IRQ_DMA3 = 0xB,
 34	IRQ_KEYPAD = 0xC,
 35	IRQ_GAMEPAK = 0xD
 36};
 37
 38enum GBALogLevel {
 39	GBA_LOG_FATAL = 0x01,
 40	GBA_LOG_ERROR = 0x02,
 41	GBA_LOG_WARN = 0x04,
 42	GBA_LOG_INFO = 0x08,
 43	GBA_LOG_DEBUG = 0x10,
 44	GBA_LOG_STUB = 0x20,
 45
 46	GBA_LOG_GAME_ERROR = 0x100,
 47	GBA_LOG_SWI = 0x200,
 48
 49	GBA_LOG_ALL = 0x33F,
 50
 51#ifdef NDEBUG
 52	GBA_LOG_DANGER = GBA_LOG_ERROR
 53#else
 54	GBA_LOG_DANGER = GBA_LOG_FATAL
 55#endif
 56};
 57
 58enum GBAKey {
 59	GBA_KEY_A = 0,
 60	GBA_KEY_B = 1,
 61	GBA_KEY_SELECT = 2,
 62	GBA_KEY_START = 3,
 63	GBA_KEY_RIGHT = 4,
 64	GBA_KEY_LEFT = 5,
 65	GBA_KEY_UP = 6,
 66	GBA_KEY_DOWN = 7,
 67	GBA_KEY_R = 8,
 68	GBA_KEY_L = 9,
 69	GBA_KEY_MAX,
 70	GBA_KEY_NONE = -1
 71};
 72
 73enum GBAComponent {
 74	GBA_COMPONENT_DEBUGGER,
 75	GBA_COMPONENT_MAX
 76};
 77
 78enum {
 79	SP_BASE_SYSTEM = 0x03007F00,
 80	SP_BASE_IRQ = 0x03007FA0,
 81	SP_BASE_SUPERVISOR = 0x03007FE0
 82};
 83
 84struct GBA;
 85struct GBARotationSource;
 86struct Patch;
 87struct VFile;
 88
 89struct GBATimer {
 90	uint16_t reload;
 91	uint16_t oldReload;
 92	int32_t lastEvent;
 93	int32_t nextEvent;
 94	int32_t overflowInterval;
 95	unsigned prescaleBits : 4;
 96	unsigned countUp : 1;
 97	unsigned doIrq : 1;
 98	unsigned enable : 1;
 99};
100
101struct GBA {
102	struct ARMComponent d;
103
104	struct ARMCore* cpu;
105	struct GBAMemory memory;
106	struct GBAVideo video;
107	struct GBAAudio audio;
108	struct GBASIO sio;
109
110	struct GBASync* sync;
111
112	struct ARMDebugger* debugger;
113
114	uint32_t bus;
115
116	int timersEnabled;
117	struct GBATimer timers[4];
118
119	int springIRQ;
120	uint32_t biosChecksum;
121	int* keySource;
122	uint32_t busyLoop;
123	struct GBARotationSource* rotationSource;
124	struct GBALuminanceSource* luminanceSource;
125	struct GBARTCSource* rtcSource;
126	struct GBARumble* rumble;
127
128	struct GBARRContext* rr;
129	void* pristineRom;
130	size_t pristineRomSize;
131	uint32_t romCrc32;
132	struct VFile* romVf;
133	struct VFile* biosVf;
134
135	const char* activeFile;
136
137	int logLevel;
138};
139
140struct GBACartridge {
141	uint32_t entry;
142	uint8_t logo[156];
143	char title[12];
144	uint32_t id;
145	uint16_t maker;
146	uint8_t type;
147	uint8_t unit;
148	uint8_t device;
149	uint8_t reserved[7];
150	uint8_t version;
151	uint8_t checksum;
152	// And ROM data...
153};
154
155void GBACreate(struct GBA* gba);
156void GBADestroy(struct GBA* gba);
157
158void GBAReset(struct ARMCore* cpu);
159void GBASkipBIOS(struct ARMCore* cpu);
160
161void GBATimerUpdateRegister(struct GBA* gba, int timer);
162void GBATimerWriteTMCNT_LO(struct GBA* gba, int timer, uint16_t value);
163void GBATimerWriteTMCNT_HI(struct GBA* gba, int timer, uint16_t value);
164
165void GBAWriteIE(struct GBA* gba, uint16_t value);
166void GBAWriteIME(struct GBA* gba, uint16_t value);
167void GBARaiseIRQ(struct GBA* gba, enum GBAIRQ irq);
168void GBATestIRQ(struct ARMCore* cpu);
169void GBAHalt(struct GBA* gba);
170
171void GBAAttachDebugger(struct GBA* gba, struct ARMDebugger* debugger);
172void GBADetachDebugger(struct GBA* gba);
173
174void GBALoadROM(struct GBA* gba, struct VFile* vf, struct VFile* sav, const char* fname);
175void GBALoadBIOS(struct GBA* gba, struct VFile* vf);
176void GBAApplyPatch(struct GBA* gba, struct Patch* patch);
177
178bool GBAIsROM(struct VFile* vf);
179bool GBAIsBIOS(struct VFile* vf);
180void GBAGetGameCode(struct GBA* gba, char* out);
181void GBAGetGameTitle(struct GBA* gba, char* out);
182
183__attribute__((format (printf, 3, 4)))
184void GBALog(struct GBA* gba, enum GBALogLevel level, const char* format, ...);
185
186__attribute__((format (printf, 3, 4)))
187void GBADebuggerLogShim(struct ARMDebugger* debugger, enum DebuggerLogLevel level, const char* format, ...);
188
189#endif