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