Cxbx-Reloaded/src/devices/chihiro/JvsIo.h

// ******************************************************************
// *  This file is part of the Cxbx project.
// *
// *  Cxbx and Cxbe are free software; you can redistribute them
// *  and/or modify them under the terms of the GNU General Public
// *  License as published by the Free Software Foundation; either
// *  version 2 of the license, or (at your option) any later version.
// *
// *  This program is distributed in the hope that it will be useful,
// *  but WITHOUT ANY WARRANTY; without even the implied warranty of
// *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// *  GNU General Public License for more details.
// *
// *  You should have recieved a copy of the GNU General Public License
// *  along with this program; see the file COPYING.
// *  If not, write to the Free Software Foundation, Inc.,
// *  59 Temple Place - Suite 330, Bostom, MA 02111-1307, USA.
// *
// *  (c) 2019 Luke Usher
// *
// *  All rights reserved
// *
// ******************************************************************

#ifndef JVSIO_H
#define JVSIO_H

#include <cstdint>
#include <vector>
#include <string>

typedef struct {
	uint8_t sync;
	uint8_t target;
	uint8_t count;
} jvs_packet_header_t;

#define JVS_MAX_PLAYERS (2)
#define JVS_MAX_ANALOG (8)
#define JVS_MAX_COINS (JVS_MAX_PLAYERS)

typedef struct _jvs_switch_player_inputs_t {
	bool start = false;
	bool service = false;
	bool up = false;
	bool down = false;
	bool left = false;
	bool right = false;
	bool button[7] = { false };

	uint8_t GetByte0() {
		uint8_t value = 0;
		value |= start ? 1 << 7 : 0;
		value |= service ? 1 << 6 : 0;
		value |= up ? 1 << 5 : 0;
		value |= down ? 1 << 4 : 0;
		value |= left ? 1 << 3 : 0;
		value |= right ? 1 << 2 : 0;
		value |= button[0] ? 1 << 1 : 0;
		value |= button[1] ? 1 << 0 : 0;
		return value;
	}

	uint8_t GetByte1() {
		uint8_t value = 0;
		value |= button[2] ? 1 << 7 : 0;
		value |= button[3] ? 1 << 6 : 0;
		value |= button[4] ? 1 << 5 : 0;
		value |= button[5] ? 1 << 4 : 0;
		value |= button[6] ? 1 << 3 : 0;
		return value;
	}
} jvs_switch_player_inputs_t;

typedef struct _jvs_switch_system_inputs_t {
	bool test = false;
	bool tilt1 = false;
	bool tilt2 = false;
	bool tilt3 = false;

	uint8_t GetByte0() {
		uint8_t value = 0;
		value |= test ? 1 << 7 : 0;
		value |= tilt1 ? 1 << 6 : 0;
		value |= tilt2 ? 1 << 5 : 0;
		value |= tilt3 ? 1 << 4 : 0;
		return value;
	}
} jvs_switch_system_inputs_t;

typedef struct {
	jvs_switch_system_inputs_t system;
	jvs_switch_player_inputs_t player[JVS_MAX_PLAYERS];
} jvs_switch_inputs_t;

typedef struct _jvs_analog_input_t {
	uint16_t value = 0x8000;

	uint8_t GetByte0() {
		return (value >> 8) & 0xFF;
	}

	uint8_t GetByte1() {
		return value & 0xFF;
	}
} jvs_analog_input_t;

typedef struct _jvs_coin_slots_t {
	uint16_t coins = 0;
	uint8_t status = 0;

	uint8_t GetByte0() {
		uint8_t value = 0;
		value |= (status << 6) & 0xC0;
		value |= (coins >> 8) & 0x3F;
		return value;
	}

	uint8_t GetByte1() {
		return coins & 0xFF;
	}
} jvs_coin_slots_t;

typedef struct {
	jvs_switch_inputs_t switches;
	jvs_analog_input_t analog[JVS_MAX_ANALOG];
	jvs_coin_slots_t coins[JVS_MAX_COINS];
} jvs_input_states_t;

class JvsIo
{
public:
	JvsIo(uint8_t *sense);
	size_t SendPacket(uint8_t *buffer);
	size_t ReceivePacket(uint8_t *buffer);
	uint8_t GetDeviceId();
	void Update();

private:
	const uint8_t SYNC_BYTE = 0xE0;
	const uint8_t ESCAPE_BYTE = 0xD0;

	const uint8_t TARGET_MASTER_DEVICE = 0x00;
	const uint8_t TARGET_BROADCAST = 0xFF;

	uint8_t GetByte(uint8_t *&buffer);
	uint8_t GetEscapedByte(uint8_t *&buffer);
	void HandlePacket(jvs_packet_header_t *header, std::vector<uint8_t> &packet);

	void SendByte(uint8_t *&buffer, uint8_t value);
	void SendEscapedByte(uint8_t *&buffer, uint8_t value);

	enum StatusCode {
		StatusOkay = 1,
		UnsupportedCommand = 2,
		ChecksumError = 3,
		AcknowledgeOverflow = 4,
	};

	enum ReportCode {
		Handled = 1,
		NotEnoughParameters = 2,
		InvalidParameter = 3,
		Busy = 4,
	};

	enum CapabilityCode {
		EndOfCapabilities = 0x00,
		// Input capabilities :
		PlayerSwitchButtonSets = 0x01,
		CoinSlots = 0x02,
		AnalogInputs = 0x03,
		RotaryInputs = 0x04, // Params : JVS_MAX_ROTARY, 0, 0
		KeycodeInputs = 0x05,
		ScreenPointerInputs = 0x06, // Params : Xbits, Ybits, JVS_MAX_POINTERS
		SwitchInputs = 0x07,
		// Output capabilities :
		CardSystem = 0x10, // Params : JVS_MAX_CARDS, 0, 0
		MedalHopper = 0x11, // Params : max?, 0, 0
		GeneralPurposeOutputs = 0x12, // Params : number of outputs, 0, 0
		AnalogOutput = 0x13, // Params : channels, 0, 0
		CharacterOutput = 0x14, // Params : width, height, type
		BackupData = 0x15,
	};

	// Commands
	// These return the additional param bytes used
	int Jvs_Command_F0_Reset(uint8_t *data);
	int Jvs_Command_F1_SetDeviceId(uint8_t *data);
	int Jvs_Command_10_GetBoardId();
	int Jvs_Command_11_GetCommandFormat();
	int Jvs_Command_12_GetJvsRevision();
	int Jvs_Command_13_GetCommunicationVersion();
	int Jvs_Command_14_GetCapabilities();
	int Jvs_Command_20_ReadSwitchInputs(uint8_t *data);
	int Jvs_Command_21_ReadCoinInputs(uint8_t *data);
	int Jvs_Command_22_ReadAnalogInputs(uint8_t *data);
	int Jvs_Command_32_GeneralPurposeOutput(uint8_t *data);

	bool BroadcastPacket;					// Set when the last command was a broadcast
	uint8_t *pSense = nullptr;				// Pointer to Sense line
	uint8_t DeviceId = 0;					// Device ID assigned by running title
	std::vector<uint8_t> ResponseBuffer;	// Command Response

	// Device info
	uint8_t CommandFormatRevision;
	uint8_t JvsVersion;
	uint8_t CommunicationVersion;
	std::string BoardID;
	jvs_input_states_t Inputs;
};

extern JvsIo *g_pJvsIo;

#endif