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
 68	void (*setSync)(struct mCore*, struct mCoreSync*);
 69	void (*loadConfig)(struct mCore*, const struct mCoreConfig*);
 70
 71	void (*desiredVideoDimensions)(struct mCore*, unsigned* width, unsigned* height);
 72	void (*setVideoBuffer)(struct mCore*, color_t* buffer, size_t stride);
 73
 74	void (*getPixels)(struct mCore*, const void** buffer, size_t* stride);
 75	void (*putPixels)(struct mCore*, const void* buffer, size_t stride);
 76
 77	struct blip_t* (*getAudioChannel)(struct mCore*, int ch);
 78	void (*setAudioBufferSize)(struct mCore*, size_t samples);
 79	size_t (*getAudioBufferSize)(struct mCore*);
 80
 81	void (*addCoreCallbacks)(struct mCore*, struct mCoreCallbacks*);
 82	void (*clearCoreCallbacks)(struct mCore*);
 83	void (*setAVStream)(struct mCore*, struct mAVStream*);
 84
 85	bool (*isROM)(struct VFile* vf);
 86	bool (*loadROM)(struct mCore*, struct VFile* vf);
 87	bool (*loadSave)(struct mCore*, struct VFile* vf);
 88	bool (*loadTemporarySave)(struct mCore*, struct VFile* vf);
 89	void (*unloadROM)(struct mCore*);
 90	void (*checksum)(const struct mCore*, void* data, enum mCoreChecksumType type);
 91
 92	bool (*loadBIOS)(struct mCore*, struct VFile* vf, int biosID);
 93	bool (*selectBIOS)(struct mCore*, int biosID);
 94
 95	bool (*loadPatch)(struct mCore*, struct VFile* vf);
 96
 97	void (*reset)(struct mCore*);
 98	void (*runFrame)(struct mCore*);
 99	void (*runLoop)(struct mCore*);
100	void (*step)(struct mCore*);
101
102	size_t (*stateSize)(struct mCore*);
103	bool (*loadState)(struct mCore*, const void* state);
104	bool (*saveState)(struct mCore*, void* state);
105
106	void (*setKeys)(struct mCore*, uint32_t keys);
107	void (*addKeys)(struct mCore*, uint32_t keys);
108	void (*clearKeys)(struct mCore*, uint32_t keys);
109
110	int32_t (*frameCounter)(const struct mCore*);
111	int32_t (*frameCycles)(const struct mCore*);
112	int32_t (*frequency)(const struct mCore*);
113
114	void (*getGameTitle)(const struct mCore*, char* title);
115	void (*getGameCode)(const struct mCore*, char* title);
116
117	void (*setPeripheral)(struct mCore*, int type, void*);
118
119	uint32_t (*busRead8)(struct mCore*, uint32_t address);
120	uint32_t (*busRead16)(struct mCore*, uint32_t address);
121	uint32_t (*busRead32)(struct mCore*, uint32_t address);
122
123	void (*busWrite8)(struct mCore*, uint32_t address, uint8_t);
124	void (*busWrite16)(struct mCore*, uint32_t address, uint16_t);
125	void (*busWrite32)(struct mCore*, uint32_t address, uint32_t);
126
127	uint32_t (*rawRead8)(struct mCore*, uint32_t address, int segment);
128	uint32_t (*rawRead16)(struct mCore*, uint32_t address, int segment);
129	uint32_t (*rawRead32)(struct mCore*, uint32_t address, int segment);
130
131	void (*rawWrite8)(struct mCore*, uint32_t address, int segment, uint8_t);
132	void (*rawWrite16)(struct mCore*, uint32_t address, int segment, uint16_t);
133	void (*rawWrite32)(struct mCore*, uint32_t address, int segment, uint32_t);
134
135	size_t (*listMemoryBlocks)(const struct mCore*, const struct mCoreMemoryBlock**);
136	void* (*getMemoryBlock)(struct mCore*, size_t id, size_t* sizeOut);
137
138#ifdef USE_DEBUGGERS
139	bool (*supportsDebuggerType)(struct mCore*, enum mDebuggerType);
140	struct mDebuggerPlatform* (*debuggerPlatform)(struct mCore*);
141	struct CLIDebuggerSystem* (*cliDebuggerSystem)(struct mCore*);
142	void (*attachDebugger)(struct mCore*, struct mDebugger*);
143	void (*detachDebugger)(struct mCore*);
144
145	void (*loadSymbols)(struct mCore*, struct VFile*);
146	bool (*lookupIdentifier)(struct mCore*, const char* name, int32_t* value, int* segment);
147#endif
148
149	struct mCheatDevice* (*cheatDevice)(struct mCore*);
150
151	size_t (*savedataClone)(struct mCore*, void** sram);
152	bool (*savedataRestore)(struct mCore*, const void* sram, size_t size, bool writeback);
153
154	size_t (*listVideoLayers)(const struct mCore*, const struct mCoreChannelInfo**);
155	size_t (*listAudioChannels)(const struct mCore*, const struct mCoreChannelInfo**);
156	void (*enableVideoLayer)(struct mCore*, size_t id, bool enable);
157	void (*enableAudioChannel)(struct mCore*, size_t id, bool enable);
158	void (*adjustVideoLayer)(struct mCore*, size_t id, int32_t x, int32_t y);
159
160#ifndef MINIMAL_CORE
161	void (*startVideoLog)(struct mCore*, struct mVideoLogContext*);
162	void (*endVideoLog)(struct mCore*);
163#endif
164};
165
166#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
167struct mCore* mCoreFind(const char* path);
168bool mCoreLoadFile(struct mCore* core, const char* path);
169
170bool mCorePreloadVF(struct mCore* core, struct VFile* vf);
171bool mCorePreloadFile(struct mCore* core, const char* path);
172
173bool mCoreAutoloadSave(struct mCore* core);
174bool mCoreAutoloadPatch(struct mCore* core);
175bool mCoreAutoloadCheats(struct mCore* core);
176
177bool mCoreSaveState(struct mCore* core, int slot, int flags);
178bool mCoreLoadState(struct mCore* core, int slot, int flags);
179struct VFile* mCoreGetState(struct mCore* core, int slot, bool write);
180void mCoreDeleteState(struct mCore* core, int slot);
181
182void mCoreTakeScreenshot(struct mCore* core);
183#endif
184
185struct mCore* mCoreFindVF(struct VFile* vf);
186enum mPlatform mCoreIsCompatible(struct VFile* vf);
187
188bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags);
189bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags);
190
191void mCoreInitConfig(struct mCore* core, const char* port);
192void mCoreLoadConfig(struct mCore* core);
193void mCoreLoadForeignConfig(struct mCore* core, const struct mCoreConfig* config);
194
195void mCoreSetRTC(struct mCore* core, struct mRTCSource* rtc);
196
197void* mCoreGetMemoryBlock(struct mCore* core, uint32_t start, size_t* size);
198
199#ifdef USE_ELF
200struct ELF;
201bool mCoreLoadELF(struct mCore* core, struct ELF* elf);
202#ifdef USE_DEBUGGERS
203void mCoreLoadELFSymbols(struct mDebuggerSymbols* symbols, struct ELF*);
204#endif
205#endif
206
207CXX_GUARD_END
208
209#endif