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