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 IS_GPIO_REGISTER(reg) ((reg) == GPIO_REG_DATA || (reg) == GPIO_REG_DIRECTION || (reg) == GPIO_REG_CONTROL)
 20
 21struct GBARTCGenericSource {
 22	struct mRTCSource d;
 23	struct GBA* p;
 24	enum mRTCGenericType override;
 25	int64_t value;
 26};
 27
 28enum GBAHardwareDevice {
 29	HW_NO_OVERRIDE = 0x8000,
 30	HW_NONE = 0,
 31	HW_RTC = 1,
 32	HW_RUMBLE = 2,
 33	HW_LIGHT_SENSOR = 4,
 34	HW_GYRO = 8,
 35	HW_TILT = 16,
 36	HW_GB_PLAYER = 32,
 37	HW_GB_PLAYER_DETECTION = 64
 38};
 39
 40enum GPIORegister {
 41	GPIO_REG_DATA = 0xC4,
 42	GPIO_REG_DIRECTION = 0xC6,
 43	GPIO_REG_CONTROL = 0xC8
 44};
 45
 46enum GPIODirection {
 47	GPIO_WRITE_ONLY = 0,
 48	GPIO_READ_WRITE = 1
 49};
 50
 51DECL_BITFIELD(RTCControl, uint8_t);
 52DECL_BIT(RTCControl, Reset, 0);
 53DECL_BIT(RTCControl, Hour24, 1);
 54DECL_BIT(RTCControl, IRQ1, 4);
 55DECL_BIT(RTCControl, IRQ2, 5);
 56
 57enum RTCCommand {
 58	RTC_STATUS1 = 0,
 59	RTC_ALARM1 = 1,
 60	RTC_DATETIME = 2,
 61	RTC_FORCE_IRQ = 3,
 62	RTC_STATUS2 = 4,
 63	RTC_ALARM2 = 5,
 64	RTC_TIME = 6,
 65	RTC_FREE_REG = 7
 66};
 67
 68DECL_BITFIELD(RTCCommandData, uint8_t);
 69DECL_BITS(RTCCommandData, Magic, 0, 4);
 70DECL_BITS(RTCCommandData, Command, 4, 3);
 71DECL_BIT(RTCCommandData, Reading, 7);
 72
 73DECL_BITFIELD(RTCStatus2, uint8_t);
 74DECL_BITS(RTCStatus2, INT1, 0, 4);
 75DECL_BIT(RTCStatus2, INT2, 6);
 76
 77#pragma pack(push, 1)
 78struct GBARTC {
 79	int32_t bytesRemaining;
 80	int32_t transferStep;
 81	int32_t bitsRead;
 82	int32_t bits;
 83	uint8_t commandActive;
 84	uint8_t alarm1[3];
 85	RTCCommandData command;
 86	RTCStatus2 status2;
 87	uint8_t freeReg;
 88	RTCControl control;
 89	uint8_t alarm2[3];
 90	uint8_t time[7];
 91};
 92#pragma pack(pop)
 93
 94struct GBAGBPKeyCallback {
 95	struct mKeyCallback d;
 96	struct GBACartridgeHardware* p;
 97};
 98
 99struct GBAGBPSIODriver {
100	struct GBASIODriver d;
101	struct GBACartridgeHardware* p;
102};
103
104DECL_BITFIELD(GPIOPin, uint16_t);
105
106struct GBACartridgeHardware {
107	struct GBA* p;
108	uint32_t devices;
109	enum GPIODirection readWrite;
110	uint16_t* gpioBase;
111
112	uint16_t pinState;
113	uint16_t direction;
114
115	struct GBARTC rtc;
116
117	uint16_t gyroSample;
118	bool gyroEdge;
119
120	unsigned lightCounter : 12;
121	uint8_t lightSample;
122	bool lightEdge;
123
124	uint16_t tiltX;
125	uint16_t tiltY;
126	int tiltState;
127
128	unsigned gbpInputsPosted;
129	int gbpTxPosition;
130	struct mTimingEvent gbpNextEvent;
131	struct GBAGBPKeyCallback gbpCallback;
132	struct GBAGBPSIODriver gbpDriver;
133};
134
135void GBAHardwareInit(struct GBACartridgeHardware* gpio, uint16_t* gpioBase);
136void GBAHardwareClear(struct GBACartridgeHardware* gpio);
137
138void GBARTCProcessByte(struct GBARTC* rtc, struct mRTCSource* source);
139unsigned GBARTCOutput(struct GBARTC* rtc);
140
141void GBAHardwareInitRTC(struct GBACartridgeHardware* gpio);
142void GBAHardwareInitGyro(struct GBACartridgeHardware* gpio);
143void GBAHardwareInitRumble(struct GBACartridgeHardware* gpio);
144void GBAHardwareInitLight(struct GBACartridgeHardware* gpio);
145void GBAHardwareInitTilt(struct GBACartridgeHardware* gpio);
146
147void GBAHardwareGPIOWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint16_t value);
148void GBAHardwareTiltWrite(struct GBACartridgeHardware* gpio, uint32_t address, uint8_t value);
149uint8_t GBAHardwareTiltRead(struct GBACartridgeHardware* gpio, uint32_t address);
150
151struct GBAVideo;
152void GBAHardwarePlayerUpdate(struct GBA* gba);
153bool GBAHardwarePlayerCheckScreen(const struct GBAVideo* video);
154
155struct GBASerializedState;
156void GBAHardwareSerialize(const struct GBACartridgeHardware* gpio, struct GBASerializedState* state);
157void GBAHardwareDeserialize(struct GBACartridgeHardware* gpio, const struct GBASerializedState* state);
158
159CXX_GUARD_END
160
161#endif