1/* Copyright (c) 2013-2015 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_HARDWARE_H
  7#define GBA_HARDWARE_H
  8
  9#include <mgba-util/common.h>
 10
 11CXX_GUARD_START
 12
 13#include <mgba/core/log.h>
 14#include <mgba/core/timing.h>
 15#include <mgba/gba/interface.h>
 16
 17mLOG_DECLARE_CATEGORY(GBA_HW);
 18
 19#define EREADER_DOTCODE_STRIDE 1420
 20#define EREADER_DOTCODE_SIZE (EREADER_DOTCODE_STRIDE * 40)
 21#define EREADER_CARDS_MAX 16
 22
 23#define IS_GPIO_REGISTER(reg) ((reg) == GPIO_REG_DATA || (reg) == GPIO_REG_DIRECTION || (reg) == GPIO_REG_CONTROL)
 24
 25struct GBARTCGenericSource {
 26	struct mRTCSource d;
 27	struct GBA* p;
 28	enum mRTCGenericType override;
 29	int64_t value;
 30};
 31
 32enum GBAHardwareDevice {
 33	HW_NO_OVERRIDE = 0x8000,
 34	HW_NONE = 0,
 35	HW_RTC = 1,
 36	HW_RUMBLE = 2,
 37	HW_LIGHT_SENSOR = 4,
 38	HW_GYRO = 8,
 39	HW_TILT = 16,
 40	HW_GB_PLAYER = 32,
 41	HW_GB_PLAYER_DETECTION = 64,
 42	HW_EREADER = 128
 43};
 44
 45enum GPIORegister {
 46	GPIO_REG_DATA = 0xC4,
 47	GPIO_REG_DIRECTION = 0xC6,
 48	GPIO_REG_CONTROL = 0xC8
 49};
 50
 51enum GPIODirection {
 52	GPIO_WRITE_ONLY = 0,
 53	GPIO_READ_WRITE = 1
 54};
 55
 56DECL_BITFIELD(RTCControl, uint8_t);
 57DECL_BIT(RTCControl, Reset, 0);
 58DECL_BIT(RTCControl, Hour24, 1);
 59DECL_BIT(RTCControl, IRQ1, 4);
 60DECL_BIT(RTCControl, IRQ2, 5);
 61
 62enum RTCCommand {
 63	RTC_STATUS1 = 0,
 64	RTC_ALARM1 = 1,
 65	RTC_DATETIME = 2,
 66	RTC_FORCE_IRQ = 3,
 67	RTC_STATUS2 = 4,
 68	RTC_ALARM2 = 5,
 69	RTC_TIME = 6,
 70	RTC_FREE_REG = 7
 71};
 72
 73DECL_BITFIELD(RTCCommandData, uint8_t);
 74DECL_BITS(RTCCommandData, Magic, 0, 4);
 75DECL_BITS(RTCCommandData, Command, 4, 3);
 76DECL_BIT(RTCCommandData, Reading, 7);
 77
 78DECL_BITFIELD(RTCStatus2, uint8_t);
 79DECL_BITS(RTCStatus2, INT1, 0, 4);
 80DECL_BIT(RTCStatus2, INT2, 6);
 81
 82#ifndef PYCPARSE
 83#pragma pack(push, 1)
 84struct GBARTC {
 85	int32_t bytesRemaining;
 86	int32_t transferStep;
 87	int32_t bitsRead;
 88	int32_t bits;
 89	uint8_t commandActive;
 90	uint8_t alarm1[3];
 91	RTCCommandData command;
 92	RTCStatus2 status2;
 93	uint8_t freeReg;
 94	RTCControl control;
 95	uint8_t alarm2[3];
 96	uint8_t time[7];
 97};
 98#pragma pack(pop)
 99#else
100struct GBATRC;
101#endif
102
103struct GBAGBPKeyCallback {
104	struct mKeyCallback d;
105	struct GBACartridgeHardware* p;
106};
107
108struct GBAGBPSIODriver {
109	struct GBASIODriver d;
110	struct GBACartridgeHardware* p;
111};
112
113DECL_BITFIELD(GPIOPin, uint16_t);
114
115DECL_BITFIELD(EReaderControl0, uint8_t);
116DECL_BIT(EReaderControl0, Data, 0);
117DECL_BIT(EReaderControl0, Clock, 1);
118DECL_BIT(EReaderControl0, Direction, 2);
119DECL_BIT(EReaderControl0, LedEnable, 3);
120DECL_BIT(EReaderControl0, Scan, 4);
121DECL_BIT(EReaderControl0, Phi, 5);
122DECL_BIT(EReaderControl0, PowerEnable, 6);
123DECL_BITFIELD(EReaderControl1, uint8_t);
124DECL_BIT(EReaderControl1, Scanline, 1);
125DECL_BIT(EReaderControl1, Unk1, 4);
126DECL_BIT(EReaderControl1, Voltage, 5);
127
128enum EReaderStateMachine {
129	EREADER_SERIAL_INACTIVE = 0,
130	EREADER_SERIAL_STARTING,
131	EREADER_SERIAL_BIT_0,
132	EREADER_SERIAL_BIT_1,
133	EREADER_SERIAL_BIT_2,
134	EREADER_SERIAL_BIT_3,
135	EREADER_SERIAL_BIT_4,
136	EREADER_SERIAL_BIT_5,
137	EREADER_SERIAL_BIT_6,
138	EREADER_SERIAL_BIT_7,
139	EREADER_SERIAL_END_BIT,
140};
141
142enum EReaderCommand {
143	EREADER_COMMAND_IDLE = 0, // TODO: Verify on hardware
144	EREADER_COMMAND_WRITE_DATA = 1,
145	EREADER_COMMAND_SET_INDEX = 0x22,
146	EREADER_COMMAND_READ_DATA = 0x23,
147};
148
149struct EReaderCard {
150	void* data;
151	size_t size;
152};
153
154struct GBACartridgeHardware {
155	struct GBA* p;
156	uint32_t devices;
157	enum GPIODirection readWrite;
158	uint16_t* gpioBase;
159
160	uint16_t pinState;
161	uint16_t direction;
162
163	struct GBARTC rtc;
164
165	uint16_t gyroSample;
166	bool gyroEdge;
167
168	unsigned lightCounter : 12;
169	uint8_t lightSample;
170	bool lightEdge;
171
172	uint16_t tiltX;
173	uint16_t tiltY;
174	int tiltState;
175
176	unsigned gbpInputsPosted;
177	int gbpTxPosition;
178	struct mTimingEvent gbpNextEvent;
179	struct GBAGBPKeyCallback gbpCallback;
180	struct GBAGBPSIODriver gbpDriver;
181
182	uint16_t eReaderData[44];
183	uint8_t eReaderSerial[92];
184	uint16_t eReaderRegisterUnk;
185	uint16_t eReaderRegisterReset;
186	EReaderControl0 eReaderRegisterControl0;
187	EReaderControl1 eReaderRegisterControl1;
188	uint16_t eReaderRegisterLed;
189
190	// TODO: Serialize these
191	enum EReaderStateMachine eReaderState;
192	enum EReaderCommand eReaderCommand;
193	uint8_t eReaderActiveRegister;
194	uint8_t eReaderByte;
195	int eReaderX;
196	int eReaderY;
197	uint8_t* eReaderDots;
198	struct EReaderCard eReaderCards[EREADER_CARDS_MAX];
199};
200
201void GBAHardwareInit(struct GBACartridgeHardware* gpio, uint16_t* gpioBase);
202void GBAHardwareClear(struct GBACartridgeHardware* gpio);
203
204void GBARTCProcessByte(struct GBARTC* rtc, struct mRTCSource* source);
205unsigned GBARTCOutput(struct GBARTC* rtc);
206
207void GBAHardwareInitRTC(struct GBACartridgeHardware* gpio);
208void GBAHardwareInitGyro(struct GBACartridgeHardware* gpio);
209void GBAHardwareInitRumble(struct GBACartridgeHardware* gpio);
210void GBAHardwareInitLight(struct GBACartridgeHardware* gpio);
211void GBAHardwareInitTilt(struct GBACartridgeHardware* gpio);
212
213void GBAHardwareGPIOWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint16_t value);
214void GBAHardwareTiltWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint8_t value);
215uint8_t GBAHardwareTiltRead(struct GBACartridgeHardware* gpio, uint32_t address);
216
217struct GBAVideo;
218void GBAHardwarePlayerUpdate(struct GBA* gba);
219bool GBAHardwarePlayerCheckScreen(const struct GBAVideo* video);
220
221void GBAHardwareInitEReader(struct GBACartridgeHardware* hw);
222void GBAHardwareEReaderWrite(struct GBACartridgeHardware* hw, uint32_t address, uint16_t value);
223void GBAHardwareEReaderWriteFlash(struct GBACartridgeHardware* hw, uint32_t address, uint8_t value);
224uint16_t GBAHardwareEReaderRead(struct GBACartridgeHardware* hw, uint32_t address);
225uint8_t GBAHardwareEReaderReadFlash(struct GBACartridgeHardware* hw, uint32_t address);
226void GBAHardwareEReaderScan(struct GBACartridgeHardware* hw, const void* data, size_t size);
227
228struct GBASerializedState;
229void GBAHardwareSerialize(const struct GBACartridgeHardware* gpio, struct GBASerializedState* state);
230void GBAHardwareDeserialize(struct GBACartridgeHardware* gpio, const struct GBASerializedState* state);
231
232CXX_GUARD_END
233
234#endif