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 M_CORE_H
  7#define M_CORE_H
  8
  9#include <mgba-util/common.h>
 10
 11CXX_GUARD_START
 12
 13#include <mgba/core/config.h>
 14#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
 15#include <mgba/core/directories.h>
 16#endif
 17#ifndef MINIMAL_CORE
 18#include <mgba/core/input.h>
 19#endif
 20#include <mgba/core/interface.h>
 21#ifdef USE_DEBUGGERS
 22#include <mgba/debugger/debugger.h>
 23#endif
 24
 25enum mPlatform {
 26	PLATFORM_NONE = -1,
 27#ifdef M_CORE_GBA
 28	PLATFORM_GBA = 0,
 29#endif
 30#ifdef M_CORE_GB
 31	PLATFORM_GB = 1,
 32#endif
 33};
 34
 35enum mCoreChecksumType {
 36	CHECKSUM_CRC32,
 37};
 38
 39struct mCoreConfig;
 40struct mCoreSync;
 41struct mDebuggerSymbols;
 42struct mStateExtdata;
 43struct mVideoLogContext;
 44struct mCore {
 45	void* cpu;
 46	void* board;
 47	struct mTiming* timing;
 48	struct mDebugger* debugger;
 49	struct mDebuggerSymbols* symbolTable;
 50	struct mVideoLogger* videoLogger;
 51
 52#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
 53	struct mDirectorySet dirs;
 54#endif
 55#ifndef MINIMAL_CORE
 56	struct mInputMap inputMap;
 57#endif
 58	struct mCoreConfig config;
 59	struct mCoreOptions opts;
 60
 61	struct mRTCGenericSource rtc;
 62
 63	bool (*init)(struct mCore*);
 64	void (*deinit)(struct mCore*);
 65
 66	enum mPlatform (*platform)(const struct mCore*);
 67	bool (*supportsFeature)(const struct mCore*, enum mCoreFeature);
 68
 69	void (*setSync)(struct mCore*, struct mCoreSync*);
 70	void (*loadConfig)(struct mCore*, const struct mCoreConfig*);
 71	void (*reloadConfigOption)(struct mCore*, const char* option, const struct mCoreConfig*);
 72
 73	void (*desiredVideoDimensions)(const struct mCore*, unsigned* width, unsigned* height);
 74	void (*setVideoBuffer)(struct mCore*, color_t* buffer, size_t stride);
 75	void (*setVideoGLTex)(struct mCore*, unsigned texid);
 76
 77	void (*getPixels)(struct mCore*, const void** buffer, size_t* stride);
 78	void (*putPixels)(struct mCore*, const void* buffer, size_t stride);
 79
 80	struct blip_t* (*getAudioChannel)(struct mCore*, int ch);
 81	void (*setAudioBufferSize)(struct mCore*, size_t samples);
 82	size_t (*getAudioBufferSize)(struct mCore*);
 83
 84	void (*addCoreCallbacks)(struct mCore*, struct mCoreCallbacks*);
 85	void (*clearCoreCallbacks)(struct mCore*);
 86	void (*setAVStream)(struct mCore*, struct mAVStream*);
 87
 88	bool (*isROM)(struct VFile* vf);
 89	bool (*loadROM)(struct mCore*, struct VFile* vf);
 90	bool (*loadSave)(struct mCore*, struct VFile* vf);
 91	bool (*loadTemporarySave)(struct mCore*, struct VFile* vf);
 92	void (*unloadROM)(struct mCore*);
 93	void (*checksum)(const struct mCore*, void* data, enum mCoreChecksumType type);
 94
 95	bool (*loadBIOS)(struct mCore*, struct VFile* vf, int biosID);
 96	bool (*selectBIOS)(struct mCore*, int biosID);
 97
 98	bool (*loadPatch)(struct mCore*, struct VFile* vf);
 99
100	void (*reset)(struct mCore*);
101	void (*runFrame)(struct mCore*);
102	void (*runLoop)(struct mCore*);
103	void (*step)(struct mCore*);
104
105	size_t (*stateSize)(struct mCore*);
106	bool (*loadState)(struct mCore*, const void* state);
107	bool (*saveState)(struct mCore*, void* state);
108
109	void (*setKeys)(struct mCore*, uint32_t keys);
110	void (*addKeys)(struct mCore*, uint32_t keys);
111	void (*clearKeys)(struct mCore*, uint32_t keys);
112
113	int32_t (*frameCounter)(const struct mCore*);
114	int32_t (*frameCycles)(const struct mCore*);
115	int32_t (*frequency)(const struct mCore*);
116
117	void (*getGameTitle)(const struct mCore*, char* title);
118	void (*getGameCode)(const struct mCore*, char* title);
119
120	void (*setPeripheral)(struct mCore*, int type, void*);
121
122	uint32_t (*busRead8)(struct mCore*, uint32_t address);
123	uint32_t (*busRead16)(struct mCore*, uint32_t address);
124	uint32_t (*busRead32)(struct mCore*, uint32_t address);
125
126	void (*busWrite8)(struct mCore*, uint32_t address, uint8_t);
127	void (*busWrite16)(struct mCore*, uint32_t address, uint16_t);
128	void (*busWrite32)(struct mCore*, uint32_t address, uint32_t);
129
130	uint32_t (*rawRead8)(struct mCore*, uint32_t address, int segment);
131	uint32_t (*rawRead16)(struct mCore*, uint32_t address, int segment);
132	uint32_t (*rawRead32)(struct mCore*, uint32_t address, int segment);
133
134	void (*rawWrite8)(struct mCore*, uint32_t address, int segment, uint8_t);
135	void (*rawWrite16)(struct mCore*, uint32_t address, int segment, uint16_t);
136	void (*rawWrite32)(struct mCore*, uint32_t address, int segment, uint32_t);
137
138	size_t (*listMemoryBlocks)(const struct mCore*, const struct mCoreMemoryBlock**);
139	void* (*getMemoryBlock)(struct mCore*, size_t id, size_t* sizeOut);
140
141#ifdef USE_DEBUGGERS
142	bool (*supportsDebuggerType)(struct mCore*, enum mDebuggerType);
143	struct mDebuggerPlatform* (*debuggerPlatform)(struct mCore*);
144	struct CLIDebuggerSystem* (*cliDebuggerSystem)(struct mCore*);
145	void (*attachDebugger)(struct mCore*, struct mDebugger*);
146	void (*detachDebugger)(struct mCore*);
147
148	void (*loadSymbols)(struct mCore*, struct VFile*);
149	bool (*lookupIdentifier)(struct mCore*, const char* name, int32_t* value, int* segment);
150#endif
151
152	struct mCheatDevice* (*cheatDevice)(struct mCore*);
153
154	size_t (*savedataClone)(struct mCore*, void** sram);
155	bool (*savedataRestore)(struct mCore*, const void* sram, size_t size, bool writeback);
156
157	size_t (*listVideoLayers)(const struct mCore*, const struct mCoreChannelInfo**);
158	size_t (*listAudioChannels)(const struct mCore*, const struct mCoreChannelInfo**);
159	void (*enableVideoLayer)(struct mCore*, size_t id, bool enable);
160	void (*enableAudioChannel)(struct mCore*, size_t id, bool enable);
161	void (*adjustVideoLayer)(struct mCore*, size_t id, int32_t x, int32_t y);
162
163#ifndef MINIMAL_CORE
164	void (*startVideoLog)(struct mCore*, struct mVideoLogContext*);
165	void (*endVideoLog)(struct mCore*);
166#endif
167};
168
169#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
170struct mCore* mCoreFind(const char* path);
171bool mCoreLoadFile(struct mCore* core, const char* path);
172
173bool mCorePreloadVF(struct mCore* core, struct VFile* vf);
174bool mCorePreloadFile(struct mCore* core, const char* path);
175
176bool mCorePreloadVFCB(struct mCore* core, struct VFile* vf, void (cb)(size_t, size_t, void*), void* context);
177bool mCorePreloadFileCB(struct mCore* core, const char* path, void (cb)(size_t, size_t, void*), void* context);
178
179bool mCoreAutoloadSave(struct mCore* core);
180bool mCoreAutoloadPatch(struct mCore* core);
181bool mCoreAutoloadCheats(struct mCore* core);
182
183bool mCoreSaveState(struct mCore* core, int slot, int flags);
184bool mCoreLoadState(struct mCore* core, int slot, int flags);
185struct VFile* mCoreGetState(struct mCore* core, int slot, bool write);
186void mCoreDeleteState(struct mCore* core, int slot);
187
188void mCoreTakeScreenshot(struct mCore* core);
189#endif
190
191struct mCore* mCoreFindVF(struct VFile* vf);
192enum mPlatform mCoreIsCompatible(struct VFile* vf);
193
194bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags);
195bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags);
196
197void mCoreInitConfig(struct mCore* core, const char* port);
198void mCoreLoadConfig(struct mCore* core);
199void mCoreLoadForeignConfig(struct mCore* core, const struct mCoreConfig* config);
200
201void mCoreSetRTC(struct mCore* core, struct mRTCSource* rtc);
202
203void* mCoreGetMemoryBlock(struct mCore* core, uint32_t start, size_t* size);
204void* mCoreGetMemoryBlockMasked(struct mCore* core, uint32_t start, size_t* size, uint32_t mask);
205
206#ifdef USE_ELF
207struct ELF;
208bool mCoreLoadELF(struct mCore* core, struct ELF* elf);
209#ifdef USE_DEBUGGERS
210void mCoreLoadELFSymbols(struct mDebuggerSymbols* symbols, struct ELF*);
211#endif
212#endif
213
214CXX_GUARD_END
215
216#endif