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
 56enum RTCCommand {
 57	RTC_STATUS1 = 0,
 58	RTC_ALARM1 = 1,
 59	RTC_DATETIME = 2,
 60	RTC_FORCE_IRQ = 3,
 61	RTC_STATUS2 = 4,
 62	RTC_ALARM2 = 5,
 63	RTC_TIME = 6,
 64	RTC_FREE_REG = 7
 65};
 66
 67DECL_BITFIELD(RTCStatus1, uint8_t);
 68DECL_BIT(RTCStatus1, Reset, 0);
 69DECL_BIT(RTCStatus1, Hour24, 1);
 70DECL_BIT(RTCStatus1, IRQ1, 4);
 71DECL_BIT(RTCStatus1, IRQ2, 5);
 72
 73DECL_BITFIELD(RTCControl, uint8_t);
 74DECL_BIT(RTCControl, MinIRQ, 3);
 75DECL_BIT(RTCControl, Hour24, 6);
 76DECL_BIT(RTCControl, Poweroff, 7);
 77
 78DECL_BITFIELD(RTCCommandData, uint8_t);
 79DECL_BITS(RTCCommandData, Magic, 0, 4);
 80DECL_BITS(RTCCommandData, Command, 4, 3);
 81DECL_BIT(RTCCommandData, Reading, 7);
 82
 83DECL_BITFIELD(RTCStatus2, uint8_t);
 84DECL_BITS(RTCStatus2, INT1, 0, 4);
 85DECL_BIT(RTCStatus2, INT2, 6);
 86
 87#ifndef PYCPARSE
 88#pragma pack(push, 1)
 89struct GBARTC {
 90	int32_t bytesRemaining;
 91	int32_t transferStep;
 92	int32_t bitsRead;
 93	int32_t bits;
 94	uint8_t commandActive;
 95	uint8_t alarm1[3];
 96	RTCCommandData command;
 97	uint8_t status1;
 98	uint8_t freeReg;
 99	uint8_t control; // Used for status2 on DS
100	uint8_t alarm2[3];
101	uint8_t time[7];
102};
103#pragma pack(pop)
104#else
105struct GBATRC;
106#endif
107
108struct GBAGBPKeyCallback {
109	struct mKeyCallback d;
110	struct GBACartridgeHardware* p;
111};
112
113struct GBAGBPSIODriver {
114	struct GBASIODriver d;
115	struct GBACartridgeHardware* p;
116};
117
118DECL_BITFIELD(GPIOPin, uint16_t);
119
120DECL_BITFIELD(EReaderControl0, uint8_t);
121DECL_BIT(EReaderControl0, Data, 0);
122DECL_BIT(EReaderControl0, Clock, 1);
123DECL_BIT(EReaderControl0, Direction, 2);
124DECL_BIT(EReaderControl0, LedEnable, 3);
125DECL_BIT(EReaderControl0, Scan, 4);
126DECL_BIT(EReaderControl0, Phi, 5);
127DECL_BIT(EReaderControl0, PowerEnable, 6);
128DECL_BITFIELD(EReaderControl1, uint8_t);
129DECL_BIT(EReaderControl1, Scanline, 1);
130DECL_BIT(EReaderControl1, Unk1, 4);
131DECL_BIT(EReaderControl1, Voltage, 5);
132
133enum EReaderStateMachine {
134	EREADER_SERIAL_INACTIVE = 0,
135	EREADER_SERIAL_STARTING,
136	EREADER_SERIAL_BIT_0,
137	EREADER_SERIAL_BIT_1,
138	EREADER_SERIAL_BIT_2,
139	EREADER_SERIAL_BIT_3,
140	EREADER_SERIAL_BIT_4,
141	EREADER_SERIAL_BIT_5,
142	EREADER_SERIAL_BIT_6,
143	EREADER_SERIAL_BIT_7,
144	EREADER_SERIAL_END_BIT,
145};
146
147enum EReaderCommand {
148	EREADER_COMMAND_IDLE = 0, // TODO: Verify on hardware
149	EREADER_COMMAND_WRITE_DATA = 1,
150	EREADER_COMMAND_SET_INDEX = 0x22,
151	EREADER_COMMAND_READ_DATA = 0x23,
152};
153
154struct EReaderCard {
155	void* data;
156	size_t size;
157};
158
159struct GBACartridgeHardware {
160	struct GBA* p;
161	uint32_t devices;
162	enum GPIODirection readWrite;
163	uint16_t* gpioBase;
164
165	uint16_t pinState;
166	uint16_t direction;
167
168	struct GBARTC rtc;
169
170	uint16_t gyroSample;
171	bool gyroEdge;
172
173	unsigned lightCounter : 12;
174	uint8_t lightSample;
175	bool lightEdge;
176
177	uint16_t tiltX;
178	uint16_t tiltY;
179	int tiltState;
180
181	unsigned gbpInputsPosted;
182	int gbpTxPosition;
183	struct mTimingEvent gbpNextEvent;
184	struct GBAGBPKeyCallback gbpCallback;
185	struct GBAGBPSIODriver gbpDriver;
186
187	uint16_t eReaderData[44];
188	uint8_t eReaderSerial[92];
189	uint16_t eReaderRegisterUnk;
190	uint16_t eReaderRegisterReset;
191	EReaderControl0 eReaderRegisterControl0;
192	EReaderControl1 eReaderRegisterControl1;
193	uint16_t eReaderRegisterLed;
194
195	// TODO: Serialize these
196	enum EReaderStateMachine eReaderState;
197	enum EReaderCommand eReaderCommand;
198	uint8_t eReaderActiveRegister;
199	uint8_t eReaderByte;
200	int eReaderX;
201	int eReaderY;
202	uint8_t* eReaderDots;
203	struct EReaderCard eReaderCards[EREADER_CARDS_MAX];
204};
205
206void GBAHardwareInit(struct GBACartridgeHardware* gpio, uint16_t* gpioBase);
207void GBAHardwareClear(struct GBACartridgeHardware* gpio);
208
209void GBARTCProcessByte(struct GBARTC* rtc, struct mRTCSource* source);
210unsigned GBARTCOutput(struct GBARTC* rtc);
211
212void GBAHardwareInitRTC(struct GBACartridgeHardware* gpio);
213void GBAHardwareInitGyro(struct GBACartridgeHardware* gpio);
214void GBAHardwareInitRumble(struct GBACartridgeHardware* gpio);
215void GBAHardwareInitLight(struct GBACartridgeHardware* gpio);
216void GBAHardwareInitTilt(struct GBACartridgeHardware* gpio);
217
218void GBAHardwareGPIOWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint16_t value);
219void GBAHardwareTiltWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint8_t value);
220uint8_t GBAHardwareTiltRead(struct GBACartridgeHardware* gpio, uint32_t address);
221
222struct GBAVideo;
223void GBAHardwarePlayerUpdate(struct GBA* gba);
224bool GBAHardwarePlayerCheckScreen(const struct GBAVideo* video);
225
226void GBAHardwareInitEReader(struct GBACartridgeHardware* hw);
227void GBAHardwareEReaderWrite(struct GBACartridgeHardware* hw, uint32_t address, uint16_t value);
228void GBAHardwareEReaderWriteFlash(struct GBACartridgeHardware* hw, uint32_t address, uint8_t value);
229uint16_t GBAHardwareEReaderRead(struct GBACartridgeHardware* hw, uint32_t address);
230uint8_t GBAHardwareEReaderReadFlash(struct GBACartridgeHardware* hw, uint32_t address);
231void GBAHardwareEReaderScan(struct GBACartridgeHardware* hw, const void* data, size_t size);
232
233struct GBASerializedState;
234void GBAHardwareSerialize(const struct GBACartridgeHardware* gpio, struct GBASerializedState* state);
235void GBAHardwareDeserialize(struct GBACartridgeHardware* gpio, const struct GBASerializedState* state);
236
237CXX_GUARD_END
238
239#endif