USB: GunCon 3 emulation

RPCS3 · Apr 29, 2024 · 050073e · 050073e
1 parent a2d9aad
commit 050073e
Show file tree

Hide file tree

Showing 15 changed files with 395 additions and 3 deletions.
diff --git a/rpcs3/Emu/CMakeLists.txt b/rpcs3/Emu/CMakeLists.txt
@@ -399,6 +399,7 @@ target_sources(rpcs3_emu PRIVATE
     Io/camera_config.cpp
     Io/GameTablet.cpp
     Io/GHLtar.cpp
+    Io/GunCon3.cpp
     Io/Infinity.cpp
     Io/interception.cpp
     Io/KeyboardHandler.cpp

diff --git a/rpcs3/Emu/Cell/lv2/sys_usbd.cpp b/rpcs3/Emu/Cell/lv2/sys_usbd.cpp
@@ -22,6 +22,7 @@
 #include "Emu/Io/Buzz.h"
 #include "Emu/Io/buzz_config.h"
 #include "Emu/Io/GameTablet.h"
+#include "Emu/Io/GunCon3.h"
 #include "Emu/Io/Turntable.h"
 #include "Emu/Io/turntable_config.h"
 #include "Emu/Io/RB3MidiKeyboard.h"
@@ -339,8 +340,8 @@ usb_handler_thread::usb_handler_thread()
 		check_device(0x054C, 0x0042, 0x0042, "buzzer2");
 		check_device(0x046D, 0xC220, 0xC220, "buzzer9");
 
-		// GCon3 Gun
-		check_device(0x0B9A, 0x0800, 0x0800, "guncon3");
+		// GunCon3 Gun
+		check_device(0x0B9A, 0x0800, 0x0800, "GunCon3");
 
 		// uDraw GameTablet
 		check_device(0x20D6, 0xCB17, 0xCB17, "uDraw GameTablet");
@@ -485,6 +486,17 @@ usb_handler_thread::usb_handler_thread()
 		sys_usbd.notice("Adding emulated uDraw GameTablet");
 		usb_devices.push_back(std::make_shared<usb_device_gametablet>(get_new_location()));
 	}
+
+	if (g_cfg.io.guncon3 >= guncon3_handler::one_controller)
+	{
+		sys_usbd.notice("Adding emulated GunCon3 (controller 1)");
+		usb_devices.push_back(std::make_shared<usb_device_guncon3>(0, get_new_location()));
+	}
+	if ( g_cfg.io.guncon3 == guncon3_handler::two_controllers)
+	{
+		sys_usbd.notice("Adding emulated GunCon3 (controller 2)");
+		usb_devices.push_back(std::make_shared<usb_device_guncon3>(1, get_new_location()));
+	}
 }
 
 usb_handler_thread::~usb_handler_thread()

diff --git a/rpcs3/Emu/Io/GunCon3.cpp b/rpcs3/Emu/Io/GunCon3.cpp
@@ -0,0 +1,301 @@
+#include "stdafx.h"
+#include "GunCon3.h"
+#include "MouseHandler.h"
+#include "Emu/IdManager.h"
+#include "Emu/Cell/lv2/sys_usbd.h"
+#include "Emu/system_config.h"
+#include "Input/pad_thread.h"
+
+LOG_CHANNEL(guncon3_log);
+
+static const u8 KEY_TABLE[] = {
+	0x91, 0xFD, 0x4C, 0x8B, 0x20, 0xC1, 0x7C, 0x09, 0x58, 0x14, 0xF6, 0x00, 0x52, 0x55, 0xBF, 0x41,
+	0x75, 0xC0, 0x13, 0x30, 0xB5, 0xD0, 0x69, 0x85, 0x89, 0xBB, 0xD6, 0x88, 0xBC, 0x73, 0x18, 0x8D,
+	0x58, 0xAB, 0x3D, 0x98, 0x5C, 0xF2, 0x48, 0xE9, 0xAC, 0x9F, 0x7A, 0x0C, 0x7C, 0x25, 0xD8, 0xFF,
+	0xDC, 0x7D, 0x08, 0xDB, 0xBC, 0x18, 0x8C, 0x1D, 0xD6, 0x3C, 0x35, 0xE1, 0x2C, 0x14, 0x8E, 0x64,
+	0x83, 0x39, 0xB0, 0xE4, 0x4E, 0xF7, 0x51, 0x7B, 0xA8, 0x13, 0xAC, 0xE9, 0x43, 0xC0, 0x08, 0x25,
+	0x0E, 0x15, 0xC4, 0x20, 0x93, 0x13, 0xF5, 0xC3, 0x48, 0xCC, 0x47, 0x1C, 0xC5, 0x20, 0xDE, 0x60,
+	0x55, 0xEE, 0xA0, 0x40, 0xB4, 0xE7, 0x74, 0x95, 0xB0, 0x46, 0xEC, 0xF0, 0xA5, 0xB8, 0x23, 0xC8,
+	0x04, 0x06, 0xFC, 0x28, 0xCB, 0xF8, 0x17, 0x2C, 0x25, 0x1C, 0xCB, 0x18, 0xE3, 0x6C, 0x80, 0x85,
+	0xDD, 0x7E, 0x09, 0xD9, 0xBC, 0x19, 0x8F, 0x1D, 0xD4, 0x3D, 0x37, 0xE1, 0x2F, 0x15, 0x8D, 0x64,
+	0x06, 0x04, 0xFD, 0x29, 0xCF, 0xFA, 0x14, 0x2E, 0x25, 0x1F, 0xC9, 0x18, 0xE3, 0x6D, 0x81, 0x84,
+	0x80, 0x3B, 0xB1, 0xE5, 0x4D, 0xF7, 0x51, 0x78, 0xA9, 0x13, 0xAD, 0xE9, 0x80, 0xC1, 0x0B, 0x25,
+	0x93, 0xFC, 0x4D, 0x89, 0x23, 0xC2, 0x7C, 0x0B, 0x59, 0x15, 0xF6, 0x01, 0x50, 0x55, 0xBF, 0x81,
+	0x75, 0xC3, 0x10, 0x31, 0xB5, 0xD3, 0x69, 0x84, 0x89, 0xBA, 0xD6, 0x89, 0xBD, 0x70, 0x19, 0x8E,
+	0x58, 0xA8, 0x3D, 0x9B, 0x5D, 0xF0, 0x49, 0xE8, 0xAD, 0x9D, 0x7A, 0x0D, 0x7E, 0x24, 0xDA, 0xFC,
+	0x0D, 0x14, 0xC5, 0x23, 0x91, 0x11, 0xF5, 0xC0, 0x4B, 0xCD, 0x44, 0x1C, 0xC5, 0x21, 0xDF, 0x61,
+	0x54, 0xED, 0xA2, 0x81, 0xB7, 0xE5, 0x74, 0x94, 0xB0, 0x47, 0xEE, 0xF1, 0xA5, 0xBB, 0x21, 0xC8
+};
+
+#pragma pack(push, 1)
+struct Guncon3_data
+{
+	uint8_t : 1;
+	uint8_t btn_a2 : 1;
+	uint8_t btn_a1 : 1;
+	uint8_t btn_c2 : 1;
+	uint8_t : 4;
+
+	uint8_t : 1;
+	uint8_t btn_b2 : 1;
+	uint8_t btn_b1 : 1;
+	uint8_t : 2;
+	uint8_t btn_trigger : 1;
+	uint8_t : 1;
+	uint8_t btn_c1 : 1;
+
+	uint8_t : 6;
+	uint8_t btn_b3 : 1;
+	uint8_t btn_a3 : 1;
+
+	int16_t gun_x;
+	int16_t gun_y;
+	int16_t gun_z;
+	uint8_t stick_bx;
+	uint8_t stick_by;
+	uint8_t stick_ax;
+	uint8_t stick_ay;
+
+	uint8_t checksum;
+	uint8_t keyindex;
+};
+#pragma pack(pop)
+
+static void guncon3_encode(u8 *data, const u8 *key)
+{
+	u8 key_offset = ((key[1] ^ key[2]) - key[3] - key[4] ^ key[5]) + key[6] - key[7] ^ data[14];
+	u8 key_index = 0;
+
+	for (int i = 0; i < 13; i++)
+	{
+		u8 byte = data[i];
+		for (int j = 0; j < 3; j++)
+		{
+			u8 bkey = KEY_TABLE[key_offset];
+			u8 keyr = key[++key_index];
+			if (key_index == 7)
+				key_index = 0;
+
+			if ((bkey & 3) == 0)
+				byte = (byte + bkey) + keyr;
+			else if ((bkey & 3) == 1)
+				byte = (byte - bkey) - keyr;
+			else
+				byte = (byte ^ bkey) ^ keyr;
+
+			key_offset++;
+		}
+		data[i] = byte;
+	}
+
+	data[13] = ((key[7] + data[0] - data[1] - data[2] ^ data[3])
+			 + data[4] + data[5] ^ data[6] ^ data[7])
+			 + data[8] + data[9] - data[10] - data[11] ^ data[12];
+}
+
+usb_device_guncon3::usb_device_guncon3(u32 controller_index, const std::array<u8, 7>& location)
+	: usb_device_emulated(location)
+	, m_controller_index(controller_index)
+{
+	device = UsbDescriptorNode(USB_DESCRIPTOR_DEVICE,
+		UsbDeviceDescriptor {
+			.bcdUSB             = 0x0110,
+			.bDeviceClass       = 0x00,
+			.bDeviceSubClass    = 0x00,
+			.bDeviceProtocol    = 0x00,
+			.bMaxPacketSize0    = 0x08,
+			.idVendor           = 0x0b9a,
+			.idProduct          = 0x0800,
+			.bcdDevice          = 0x8000,
+			.iManufacturer      = 0x00,
+			.iProduct           = 0x00,
+			.iSerialNumber      = 0x00,
+			.bNumConfigurations = 0x01});
+	auto& config0 = device.add_node(UsbDescriptorNode(USB_DESCRIPTOR_CONFIG,
+		UsbDeviceConfiguration {
+			.wTotalLength        = 0x0020,
+			.bNumInterfaces      = 0x01,
+			.bConfigurationValue = 0x01,
+			.iConfiguration      = 0x00,
+			.bmAttributes        = 0x00,
+			.bMaxPower           = 0x32}));
+	config0.add_node(UsbDescriptorNode(USB_DESCRIPTOR_INTERFACE,
+		UsbDeviceInterface {
+			.bInterfaceNumber   = 0x00,
+			.bAlternateSetting  = 0x00,
+			.bNumEndpoints      = 0x02,
+			.bInterfaceClass    = 0xff,
+			.bInterfaceSubClass = 0x00,
+			.bInterfaceProtocol = 0x00,
+			.iInterface         = 0x00}));
+	config0.add_node(UsbDescriptorNode(USB_DESCRIPTOR_ENDPOINT,
+		UsbDeviceEndpoint {
+			.bEndpointAddress = 0x02,
+			.bmAttributes     = 0x03,
+			.wMaxPacketSize   = 0x0008,
+			.bInterval        = 0x10}));
+	config0.add_node(UsbDescriptorNode(USB_DESCRIPTOR_ENDPOINT,
+		UsbDeviceEndpoint {
+			.bEndpointAddress = 0x82,
+			.bmAttributes     = 0x03,
+			.wMaxPacketSize   = 0x000f,
+			.bInterval        = 0x04}));
+}
+
+usb_device_guncon3::~usb_device_guncon3()
+{
+}
+
+void usb_device_guncon3::control_transfer(u8 bmRequestType, u8 bRequest, u16 wValue, u16 wIndex, u16 wLength, u32 buf_size, u8* buf, UsbTransfer* transfer)
+{
+	transfer->fake            = true;
+	transfer->expected_count  = buf_size;
+	transfer->expected_result = HC_CC_NOERR;
+	transfer->expected_time   = get_timestamp() + 100;
+
+	usb_device_emulated::control_transfer(bmRequestType, bRequest, wValue, wIndex, wLength, buf_size, buf, transfer);
+}
+
+extern bool is_input_allowed();
+
+void usb_device_guncon3::interrupt_transfer(u32 buf_size, u8* buf, u32 endpoint, UsbTransfer* transfer)
+{
+	transfer->fake = true;
+	transfer->expected_count = buf_size;
+	transfer->expected_result = HC_CC_NOERR;
+	transfer->expected_time = get_timestamp() + 500;
+
+	if ((endpoint & 0x80) == LIBUSB_ENDPOINT_OUT)
+	{
+		std::memcpy(m_key, buf, std::min(buf_size, (u32)sizeof(m_key)));
+		return;
+	}
+	// else ENDPOINT_IN
+
+	ensure(buf_size >= sizeof(struct Guncon3_data));
+	std::memset(buf, 0, buf_size);
+	struct Guncon3_data* gd = (struct Guncon3_data*) buf;
+
+	gd->stick_ax = gd->stick_ay = gd->stick_bx = gd->stick_by = 0x7f;
+
+	if (!is_input_allowed())
+	{
+		goto encode;
+	}
+
+	if (g_cfg.io.mouse == mouse_handler::null)
+	{
+		guncon3_log.warning("GunCon3 requires a Mouse Handler enabled");
+		goto encode;
+	}
+
+	{
+		std::lock_guard lock(pad::g_pad_mutex);
+		const auto gamepad_handler = pad::get_current_handler();
+		const auto& pads = gamepad_handler->GetPads();
+
+		const auto& pad = ::at32(pads, m_controller_index);
+		if (pad->m_port_status & CELL_PAD_STATUS_CONNECTED)
+		{
+			for (const Button& button : pad->m_buttons)
+			{
+				if (!button.m_pressed)
+				{
+					continue;
+				}
+
+				if (button.m_offset == CELL_PAD_BTN_OFFSET_DIGITAL1)
+				{
+					switch (button.m_outKeyCode)
+					{
+					case CELL_PAD_CTRL_L3:
+						gd->btn_a3 |= 1;
+						break;
+					case CELL_PAD_CTRL_R3:
+						gd->btn_b3 |= 1;
+						break;
+					case CELL_PAD_CTRL_SELECT:
+						gd->btn_c1 |= 1;
+						break;
+					case CELL_PAD_CTRL_START:
+						gd->btn_c2 |= 1;
+						break;
+					default:
+						break;
+					}
+				}
+				else if (button.m_offset == CELL_PAD_BTN_OFFSET_DIGITAL2)
+				{
+					switch (button.m_outKeyCode)
+					{
+					case CELL_PAD_CTRL_CROSS:
+						gd->btn_trigger |= 1;
+						break;
+					case CELL_PAD_CTRL_L1:
+						gd->btn_a1 |= 1;
+						break;
+					case CELL_PAD_CTRL_L2:
+						gd->btn_a2 |= 1;
+						break;
+					case CELL_PAD_CTRL_R1:
+						gd->btn_b1 |= 1;
+						break;
+					case CELL_PAD_CTRL_R2:
+						gd->btn_b2 |= 1;
+						break;
+					default:
+						break;
+					}
+				}
+			}
+
+			for (const AnalogStick& stick : pad->m_sticks)
+			{
+				switch (stick.m_offset)
+				{
+				case CELL_PAD_BTN_OFFSET_ANALOG_LEFT_X:
+					gd->stick_ax = static_cast<uint8_t>(stick.m_value);
+					break;
+				case CELL_PAD_BTN_OFFSET_ANALOG_LEFT_Y:
+					gd->stick_ay = static_cast<uint8_t>(stick.m_value);
+					break;
+				case CELL_PAD_BTN_OFFSET_ANALOG_RIGHT_X:
+					gd->stick_bx = static_cast<uint8_t>(stick.m_value);
+					break;
+				case CELL_PAD_BTN_OFFSET_ANALOG_RIGHT_Y:
+					gd->stick_by = static_cast<uint8_t>(stick.m_value);
+					break;
+				default:
+					break;
+				}
+			}
+		}
+	}
+
+	{
+		auto& mouse_handler = g_fxo->get<MouseHandlerBase>();
+		std::lock_guard mouse_lock(mouse_handler.mutex);
+
+		mouse_handler.Init(2);
+
+		if (m_controller_index >= mouse_handler.GetMice().size())
+		{
+			goto encode;
+		}
+
+		const Mouse& mouse_data = ::at32(mouse_handler.GetMice(), m_controller_index);
+		if (mouse_data.x_max <= 0 || mouse_data.y_max <= 0)
+		{
+			goto encode;
+		}
+
+		// Expand 0..+wh to -32767..+32767
+		gd->gun_x = (mouse_data.x_pos * USHRT_MAX / mouse_data.x_max) - SHRT_MAX;
+		gd->gun_y = (mouse_data.y_pos * -USHRT_MAX / mouse_data.y_max) + SHRT_MAX;
+
+		gd->btn_trigger |= !!(mouse_data.buttons & CELL_MOUSE_BUTTON_1);
+	}
+
+encode:
+	guncon3_encode(buf, m_key);
+}
diff --git a/rpcs3/Emu/Io/GunCon3.h b/rpcs3/Emu/Io/GunCon3.h
@@ -0,0 +1,17 @@
+#pragma once
+
+#include "Emu/Io/usb_device.h"
+
+class usb_device_guncon3 : public usb_device_emulated
+{
+public:
+	usb_device_guncon3(u32 controller_index, const std::array<u8, 7>& location);
+	~usb_device_guncon3();
+
+	void control_transfer(u8 bmRequestType, u8 bRequest, u16 wValue, u16 wIndex, u16 wLength, u32 buf_size, u8* buf, UsbTransfer* transfer) override;
+	void interrupt_transfer(u32 buf_size, u8* buf, u32 endpoint, UsbTransfer* transfer) override;
+
+private:
+	u32 m_controller_index;
+	u8 m_key[8];
+};
diff --git a/rpcs3/Emu/system_config.h b/rpcs3/Emu/system_config.h
@@ -275,6 +275,7 @@ struct cfg_root : cfg::node
 		cfg::_enum<turntable_handler> turntable{this, "Turntable emulated controller", turntable_handler::null};
 		cfg::_enum<ghltar_handler> ghltar{this, "GHLtar emulated controller", ghltar_handler::null};
 		cfg::_enum<gametablet_handler> gametablet{this, "GameTablet emulated controller", gametablet_handler::disabled};
+		cfg::_enum<guncon3_handler> guncon3{this, "GunCon3 emulated controller", guncon3_handler::disabled};
 		cfg::_enum<pad_handler_mode> pad_mode{this, "Pad handler mode", pad_handler_mode::single_threaded, true};
 		cfg::_bool keep_pads_connected{this, "Keep pads connected", false, true};
 		cfg::uint<0, 100'000> pad_sleep{this, "Pad handler sleep (microseconds)", 1'000, true};

diff --git a/rpcs3/Emu/system_config_types.cpp b/rpcs3/Emu/system_config_types.cpp
@@ -522,6 +522,22 @@ void fmt_class_string<gametablet_handler>::format(std::string& out, u64 arg)
 	});
 }
 
+template <>
+void fmt_class_string<guncon3_handler>::format(std::string& out, u64 arg)
+{
+	format_enum(out, arg, [](auto value)
+	{
+		switch (value)
+		{
+		case guncon3_handler::disabled: return "Disabled";
+		case guncon3_handler::one_controller: return "1 controller";
+		case guncon3_handler::two_controllers: return "2 controllers";
+		}
+
+		return unknown;
+	});
+}
+
 template <>
 void fmt_class_string<ppu_decoder_type>::format(std::string& out, u64 arg)
 {