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