feat: Virtual SNES mouse support. (#45)

iequalshane · web-flow · commit 120c7c0e9a03 · 2022-10-12T14:52:13.000-07:00
* feat: Virtual SNES mouse support.

* Added joystick support for SNES mouse. Updated README.

* Adding joystick detection to SNES Mouse to deal with the joystick appearing to be in the upper-left corner when the Pocket has never been docked in the current boot cycle.

* Added a joystick deadzone setting for virtual mouse and lightguns.

* Adjusting joystick setting name length and default value.
diff --git a/README.md b/README.md
@@ -39,8 +39,23 @@ The Analogue Pocket framework doesn't currently allow for customizing video mode
 
 Proper PAL support also requires editing these files to have an expanded vertical pixel height.
 
+### Controller Options
+
+There are several options provided for selecting which type of controller the core will emulate.
+
+* `Gamepad` - The standard SNES controller used with most games.
+* `Super Scope` - The Super Scope lightgun that's used with most lightgun games. See Lightguns for more details.
+* `Justifier` - The Justifier lightgun that's used with Lethal Enforcers. See Lightguns for more details.
+* `Mouse` - The SNES mouse that's used with Mario Paint and several other games. See SNES Mouse for more details.
+
 ### Lightguns
 
-Core supports virtual lightguns by enabling the "Use Super Scope" or "Use Justifier" settings. Most lightgun games user the Super Scope but Lethal Enforcers uses the Justifier. The crosshair can be controlled with the D-Pad or left joystick, using the A button to fire and the B button to reload. D-Pad aim sensitivity can be adjusted with the "D-Pad Aim Speed" setting.
+Core supports virtual lightguns by selecting the "Super Scope" or "Justifier" options under "Controller Options". Most lightgun games user the Super Scope but Lethal Enforcers uses the Justifier. The crosshair can be controlled with the D-Pad or left joystick, using the A button to fire and the B button to reload. D-Pad aim sensitivity can be adjusted with the "D-Pad Aim Speed" setting.
+
+**NOTE:** Joystick support for aiming only appears to work when a controller is paired over Bluetooth and not connected to the Analogue Dock directly by USB.
+
+### SNES Mouse
+
+Core supports a virtual SNES mouse by selecting "Mouse" under "Controller Options". The mouse can be moved with the D-Pad or left joystick and left and right clicks can be performed by pressing the A and B buttons respectively. Mouse D-Pad movement sensitivity can be adjusted with the "D-Pad Aim Speed" setting.
 
-**NOTE:** Joystick support for aiming only appears to work when a controller is paired over Bluetooth and not connected to the Analogue Dock directly by USB.
+**NOTE:** The dock firmware doesn't currently support a USB mouse.
diff --git a/dist/Cores/agg23.SNES/interact.json b/dist/Cores/agg23.SNES/interact.json
@@ -22,7 +22,7 @@
         "value": 1
       },
       {
-        "name": "Lightgun Options",
+        "name": "Controller Options",
         "id": 30,
         "type": "list",
         "enabled": true,
@@ -32,16 +32,20 @@
         "defaultval": 0,
         "options": [
           {
-            "name": "No Lightgun",
+            "name": "Gamepad",
             "value": 0
           },
           {
-            "name": "Use Super Scope",
+            "name": "Super Scope",
             "value": 1
           },
           {
-            "name": "Use Justifier",
-            "value": 2
+            "name": "Justifier",
+            "value": 3
+          },
+          {
+            "name": "Mouse",
+            "value": 4
           }
         ]
       },
@@ -62,6 +66,23 @@
           "adjust_large": 4
         }
       },
+      {
+        "name": "Joy Deadzone",
+        "id": 35,
+        "type": "slider_u32",
+        "enabled": true,
+        "address": "0x0000010C",
+        "persist": true,
+        "writeonly": true,
+        "defaultval": 0,
+        "graphical": {
+          "signed": false,
+          "min": 0,
+          "max": 64,
+          "adjust_small": 1,
+          "adjust_large": 10
+        }
+      },
       {
         "name": "Use 4:3 video",
         "id": 40,
diff --git a/src/fpga/core/core_top.v b/src/fpga/core/core_top.v
@@ -344,9 +344,13 @@ module core_top (
         32'h00000104: begin
           lightgun_enabled <= bridge_wr_data[0];
           lightgun_type    <= bridge_wr_data[1];
+          mouse_enabled    <= bridge_wr_data[2];
         end
         32'h00000108: begin
-          lightgun_dpad_aim_speed <= bridge_wr_data[7:0];
+          dpad_aim_speed <= bridge_wr_data[7:0];
+        end
+        32'h0000010C: begin
+          joystick_deadzone <= bridge_wr_data[7:0];
         end
         32'h00000200: begin
           use_4_3_video <= bridge_wr_data[0];
@@ -602,6 +606,14 @@ module core_top (
   wire [15:0] cont4_key_s;
   wire [31:0] cont1_joy_s;
 
+  wire [15:0] cont1_joy_x = cont1_joy_s[7:0];
+  wire [15:0] cont1_joy_y = cont1_joy_s[15:8];
+  wire [15:0] cont1_joy_dx = cont1_joy_x[7] ? cont1_joy_x[6:0] : 8'd128 - cont1_joy_x[6:0];
+  wire [15:0] cont1_joy_dy = cont1_joy_y[7] ? cont1_joy_y[6:0] : 8'd128 - cont1_joy_y[6:0];
+  wire [16:0] cont1_joy_total = cont1_joy_dx  + cont1_joy_dy;
+  wire [15:0] cont1_joy_x_calibrated = cont1_joy_total > joystick_deadzone ? cont1_joy_x : 8'd128;
+  wire [15:0] cont1_joy_y_calibrated = cont1_joy_total > joystick_deadzone ? cont1_joy_y : 8'd128;
+
   synch_3 #(
       .WIDTH(32)
   ) cont1_s (
@@ -648,7 +660,9 @@ module core_top (
   reg multitap_enabled;
   reg lightgun_enabled;
   reg lightgun_type;
-  reg [7:0] lightgun_dpad_aim_speed;
+  reg [7:0] dpad_aim_speed;
+  reg [7:0] joystick_deadzone;
+  reg mouse_enabled;
   reg use_4_3_video;
 
   reg [31:0] reset_delay = 0;
@@ -663,7 +677,8 @@ module core_top (
       .multitap_enabled(multitap_enabled),
       .lightgun_enabled(lightgun_enabled),
       .lightgun_type(lightgun_type),
-      .lightgun_dpad_aim_speed(lightgun_dpad_aim_speed),
+      .dpad_aim_speed(dpad_aim_speed),
+      .mouse_enabled(mouse_enabled),
 
       // Input
       .p1_button_a(cont1_key_s[4]),
@@ -679,8 +694,8 @@ module core_top (
       .p1_dpad_left(cont1_key_s[2]),
       .p1_dpad_right(cont1_key_s[3]),
 
-      .p1_lstick_x(cont1_joy_s[7:0]),
-      .p1_lstick_y(cont1_joy_s[15:8]),
+      .p1_lstick_x(cont1_joy_x_calibrated),
+      .p1_lstick_y(cont1_joy_y_calibrated),
 
       .p2_button_a(cont2_key_s[4]),
       .p2_button_b(cont2_key_s[5]),
diff --git a/src/fpga/core/rtl/ioport.sv b/src/fpga/core/rtl/ioport.sv
@@ -15,7 +15,11 @@ module ioport
 	input	[11:0] JOYSTICK3,
 	input	[11:0] JOYSTICK4,
 
-	input	[24:0] MOUSE,
+	input [7:0]  JOY_X,
+	input [7:0]  JOY_Y,
+
+	input [7:0]  DPAD_AIM_SPEED,
+
 	input        MOUSE_EN
 );
 
@@ -39,6 +43,7 @@ wire [15:0] JOY1 = {JOYSTICK[{JOYn,1'b1}][5],  JOYSTICK[{JOYn,1'b1}][7],
                     JOYSTICK[{JOYn,1'b1}][4],  JOYSTICK[{JOYn,1'b1}][6],
                     JOYSTICK[{JOYn,1'b1}][8],  JOYSTICK[{JOYn,1'b1}][9], 4'b0000};
 
+// Gamepads
 reg [15:0] JOY_LATCH0;
 always @(posedge CLK) begin
 	reg old_clk, old_n;
@@ -57,13 +62,19 @@ always @(posedge CLK) begin
 	else if (~old_clk & PORT_CLK) JOY_LATCH1 <= JOY_LATCH1 << 1;
 end
 
-reg  [10:0] curdx;
-reg  [10:0] curdy;
-wire [10:0] newdx = curdx + {{3{MOUSE[4]}},MOUSE[15:8]}  + ((speed == 2) ? {{3{MOUSE[4]}},MOUSE[15:8]}  : (speed == 1) ? {{4{MOUSE[4]}},MOUSE[15:9]}  : 11'd0);
-wire [10:0] newdy = curdy + {{3{MOUSE[5]}},MOUSE[23:16]} + ((speed == 2) ? {{3{MOUSE[5]}},MOUSE[23:16]} : (speed == 1) ? {{4{MOUSE[5]}},MOUSE[23:17]} : 11'd0);
-wire  [6:0] dx = curdx[10] ? -curdx[6:0] : curdx[6:0];
-wire  [6:0] dy = curdy[10] ? -curdy[6:0] : curdy[6:0];
-
+// Mouse
+wire dpad_mouse_sdy = JOYSTICK1[3];
+wire dpad_mouse_sdx = JOYSTICK1[1];
+wire [6:0] dpad_mouse_dy = JOYSTICK1[3] | JOYSTICK1[2] ? DPAD_AIM_SPEED[6:0] : 7'd0;
+wire [6:0] dpad_mouse_dx = JOYSTICK1[0] | JOYSTICK1[1] ? DPAD_AIM_SPEED[6:0] : 7'd0;
+wire joy_mouse_sdy = ~JOY_Y[7];
+wire joy_mouse_sdx = ~JOY_X[7];
+wire [6:0] joy_mouse_dy = joy_mouse_sdy ? (8'd128-JOY_Y) >> 4 : (JOY_Y[6:0]) >> 4;
+wire [6:0] joy_mouse_dx = joy_mouse_sdx ? (8'd128-JOY_X) >> 4 : (JOY_X[6:0]) >> 4;
+wire mouse_left = JOYSTICK1[5];
+wire mouse_right = JOYSTICK1[4];
+
+reg joystick_detected = 0;
 reg  [1:0] speed = 0;
 reg [31:0] MS_LATCH;
 always @(posedge CLK) begin
@@ -73,26 +84,15 @@ always @(posedge CLK) begin
 	old_clk <= PORT_CLK;
 	old_latch <= PORT_LATCH;
 
+	if (JOY_Y || JOY_X)
+		joystick_detected <= 1'b1;
+
 	if(old_latch & ~PORT_LATCH) begin
-		MS_LATCH <= ~{8'h00, MOUSE[1:0],speed,4'b0001,sdy,dy,sdx,dx};
-		curdx <= 0;
-		curdy <= 0;
-	end
-	else begin
-		old_stb <= MOUSE[24];
-		if(old_stb != MOUSE[24]) begin
-			if($signed(newdx) > $signed(10'd127)) curdx <= 10'd127;
-			else if($signed(newdx) < $signed(-10'd127)) curdx <= -10'd127;
-			else curdx <= newdx;
-			
-			sdx <= newdx[10];
-
-			if($signed(newdy) > $signed(10'd127)) curdy <= 10'd127;
-			else if($signed(newdy) < $signed(-10'd127)) curdy <= -10'd127;
-			else curdy <= newdy;
-
-			sdy <= ~newdy[10];
-		end;
+		if(joystick_detected && (joy_mouse_dy + joy_mouse_dx > 0)) begin
+			MS_LATCH <= ~{8'h00, mouse_left, mouse_right, speed, 4'b0001, joy_mouse_sdy, joy_mouse_dy, joy_mouse_sdx, joy_mouse_dx};
+		end else begin
+			MS_LATCH <= ~{8'h00, mouse_left, mouse_right, speed, 4'b0001, dpad_mouse_sdy, dpad_mouse_dy, dpad_mouse_sdx, dpad_mouse_dx};
+		end
 	end
 
 	if(~old_clk & PORT_CLK) begin
diff --git a/src/fpga/core/rtl/lightgun.sv b/src/fpga/core/rtl/lightgun.sv
@@ -78,7 +78,6 @@ reg  [8:0] lg_x, lg_y, x, y;
 wire [9:0] new_x = {lg_x[8],lg_x};// + {{2{MOUSE[4]}},MOUSE[15:8]};
 wire [9:0] new_y = {lg_y[8],lg_y};// - {{2{MOUSE[5]}},MOUSE[23:16]};
 
-// HACK
 reg [7:0] old_joy_x;
 reg [7:0] old_joy_y;
 reg [8:0] j_x;
diff --git a/src/fpga/core/rtl/mister_top/SNES.sv b/src/fpga/core/rtl/mister_top/SNES.sv
@@ -8,7 +8,8 @@ module MAIN_SNES (
     input wire multitap_enabled,
     input wire lightgun_enabled,
     input wire lightgun_type,
-    input wire [7:0] lightgun_dpad_aim_speed,
+    input wire [7:0] dpad_aim_speed,
+    input wire mouse_enabled,
 
     // Inputs
     input wire p1_button_a,
@@ -770,9 +771,11 @@ module MAIN_SNES (
       .PORT_DO(JOY1_DO_t),
 
       .JOYSTICK1(joy_swap ? joy1 : joy0),
+      .JOY_X(p1_lstick_x),
+      .JOY_Y(p1_lstick_y),
 
-      // .MOUSE(ps2_mouse),
-      // .MOUSE_EN(mouse_mode[0])
+      .DPAD_AIM_SPEED(dpad_aim_speed),
+      .MOUSE_EN(mouse_enabled)
   );
 
   wire [1:0] JOY2_DO;
@@ -817,7 +820,7 @@ module MAIN_SNES (
       .DOWN(p1_dpad_down),
       .LEFT(p1_dpad_left),
       .RIGHT(p1_dpad_right),
-      .DPAD_AIM_SPEED(lightgun_dpad_aim_speed),
+      .DPAD_AIM_SPEED(dpad_aim_speed),
 
       .HDE(hblank_n),
       .VDE(vblank_n),
