Skip to content

Commit

Permalink
[WIP] xpadneo, mouse: Implement mouse support
Browse files Browse the repository at this point in the history
Co-authored-by: Jacob Essex <[email protected]>
Co-authored-by: Florian Dollinger <[email protected]>
Closes: atar-axis#160
Closes: atar-axis#105
Closes: atar-axis#99
Signed-off-by: Kai Krakow <[email protected]>
  • Loading branch information
3 people committed Feb 23, 2024
1 parent 08106d8 commit 7558671
Show file tree
Hide file tree
Showing 6 changed files with 192 additions and 16 deletions.
15 changes: 15 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,21 @@ or Y while holding down the Xbox logo button. However, the following caveats app
- If you hold the button for too long, the controller will turn off - we cannot prevent that.


### Mouse Profile Support

The driver can switch to emulating a mouse (and limited keyboard) on all supported controllers. Press
<key>Guide</key>+<key>Select</key> to switch to mouse mode or back to controller mode:

- Left stick moves the mouse pointer
- Right stick can be used as a scrolling wheel/ball
- Triggers for left and right mouse button
- Shoulder buttons for back and forward button
- D-pad for cursor movement
- Menu to show on-screen keyboard (FIXME possible? KEY_KEYBOARD)
- A for <key>Enter</key>
- B for <key>Escape</key>


## Getting Started

### Distribution Packages
Expand Down
2 changes: 1 addition & 1 deletion hid-xpadneo/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ hid-xpadneo-y += xpadneo.o
$(obj)/xpadneo.c: $(src)/hid-xpadneo.c
cp $< $@

hid-xpadneo-y += xpadneo/core.o xpadneo/consumer.o xpadneo/keyboard.o
hid-xpadneo-y += xpadneo/core.o xpadneo/consumer.o xpadneo/keyboard.o xpadneo/mouse.o
26 changes: 12 additions & 14 deletions hid-xpadneo/src/hid-xpadneo.c
Original file line number Diff line number Diff line change
Expand Up @@ -710,20 +710,6 @@ static u8 *xpadneo_report_fixup(struct hid_device *hdev, u8 *rdesc, unsigned int
return rdesc;
}

static void xpadneo_toggle_mouse(struct xpadneo_devdata *xdata)
{
if (xdata->mouse_mode) {
xdata->mouse_mode = false;
hid_info(xdata->hdev, "mouse mode disabled\n");
} else {
xdata->mouse_mode = true;
hid_info(xdata->hdev, "mouse mode enabled\n");
}

/* Indicate that a request was made */
xdata->profile_switched = true;
}

static void xpadneo_switch_profile(struct xpadneo_devdata *xdata, const u8 profile,
const bool emulated)
{
Expand Down Expand Up @@ -862,6 +848,7 @@ static int xpadneo_input_configured(struct hid_device *hdev, struct hid_input *h
return 0;
default:
hid_warn(hdev, "unhandled input application 0x%x\n", hi->application);
return 0;
}

if (param_disable_deadzones) {
Expand Down Expand Up @@ -911,6 +898,9 @@ static int xpadneo_event(struct hid_device *hdev, struct hid_field *field,
struct input_dev *gamepad = xdata->gamepad;
struct input_dev *keyboard = xdata->keyboard;

if (xpadneo_mouse_event(xdata, usage, value))
goto stop_processing;

if ((usage->type == EV_KEY) && (usage->code == BTN_PADDLES(0))) {
if (gamepad && xdata->profile == 0) {
/* report the paddles individually */
Expand Down Expand Up @@ -1197,6 +1187,10 @@ static int xpadneo_probe(struct hid_device *hdev, const struct hid_device_id *id
if (ret)
return ret;

ret = xpadneo_init_mouse(xdata);
if (ret)
return ret;

ret = xpadneo_init_hw(hdev);
if (ret) {
hid_err(hdev, "hw init failed: %d\n", ret);
Expand All @@ -1208,6 +1202,9 @@ static int xpadneo_probe(struct hid_device *hdev, const struct hid_device_id *id
if (ret)
hid_err(hdev, "could not initialize ff, continuing anyway\n");

timer_setup(&xdata->mouse_timer, xpadneo_mouse_report, 0);
mod_timer(&xdata->mouse_timer, jiffies);

hid_info(hdev, "%s connected\n", xdata->battery.name);

return 0;
Expand Down Expand Up @@ -1243,6 +1240,7 @@ static void xpadneo_remove(struct hid_device *hdev)
hdev->product = xdata->original_product;
}

del_timer_sync(&xdata->mouse_timer);
cancel_delayed_work_sync(&xdata->ff_worker);

kfree(xdata->battery.name);
Expand Down
14 changes: 13 additions & 1 deletion hid-xpadneo/src/xpadneo.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#define XPADNEO_H_FILE

#include <linux/hid.h>
#include <linux/timer.h>
#include <linux/version.h>

#include "hid-ids.h"
Expand Down Expand Up @@ -138,7 +139,7 @@ struct xpadneo_devdata {

/* logical device interfaces */
struct hid_device *hdev;
struct input_dev *consumer, *gamepad, *keyboard;
struct input_dev *consumer, *gamepad, *keyboard, *mouse;
short int missing_reported;

/* revert fixups on removal */
Expand All @@ -155,6 +156,13 @@ struct xpadneo_devdata {

/* mouse mode */
bool mouse_mode;
struct timer_list mouse_timer;
struct {
s32 rel_x, rel_y, wheel_x, wheel_y;
struct {
bool left, right;
} analog_button;
} mouse_state;

/* trigger scale */
struct {
Expand Down Expand Up @@ -192,6 +200,10 @@ struct xpadneo_devdata {

extern int xpadneo_init_consumer(struct xpadneo_devdata *);
extern int xpadneo_init_keyboard(struct xpadneo_devdata *);
extern int xpadneo_init_mouse(struct xpadneo_devdata *);
extern int xpadneo_init_synthetic(struct xpadneo_devdata *, char *, struct input_dev **);
extern int xpadneo_mouse_event(struct xpadneo_devdata *, struct hid_usage *, __s32);
extern void xpadneo_mouse_report(struct timer_list *);
extern void xpadneo_toggle_mouse(struct xpadneo_devdata *);

#endif
1 change: 1 addition & 0 deletions hid-xpadneo/src/xpadneo/keyboard.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ extern int xpadneo_init_keyboard(struct xpadneo_devdata *xdata)

/* enable key events for keyboard */
input_set_capability(xdata->keyboard, EV_KEY, BTN_SHARE);
input_set_capability(xdata->consumer, EV_KEY, KEY_KEYBOARD);

if (synth) {
ret = input_register_device(xdata->keyboard);
Expand Down
150 changes: 150 additions & 0 deletions hid-xpadneo/src/xpadneo/mouse.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
/*
* xpadneo mouse driver
*
* Copyright (c) 2021 Kai Krakow <[email protected]>
*/

#include "../xpadneo.h"

extern void xpadneo_toggle_mouse(struct xpadneo_devdata *xdata)
{
if (!xdata->mouse) {
xdata->mouse_mode = false;
hid_info(xdata->hdev, "mouse not available\n");
} else if (xdata->mouse_mode) {
xdata->mouse_mode = false;
hid_info(xdata->hdev, "mouse mode disabled\n");
} else {
xdata->mouse_mode = true;
hid_info(xdata->hdev, "mouse mode enabled\n");
}

/* Indicate that a request was made */
xdata->profile_switched = true;
}

#define mouse_report_rel(a,v) if((v)!=0)input_report_rel(mouse,a,v)
extern void xpadneo_mouse_report(struct timer_list *t)
{
struct xpadneo_devdata *xdata = from_timer(xdata, t, mouse_timer);
struct input_dev *mouse = xdata->mouse;

mod_timer(&xdata->mouse_timer, jiffies + msecs_to_jiffies(10));

if (xdata->mouse_mode) {
mouse_report_rel(REL_X, xdata->mouse_state.rel_x);
mouse_report_rel(REL_Y, xdata->mouse_state.rel_y);
mouse_report_rel(REL_HWHEEL, xdata->mouse_state.wheel_x);
mouse_report_rel(REL_WHEEL, xdata->mouse_state.wheel_y);
input_sync(xdata->mouse);
}

}

#define rescale_axis(v,d) (((v)<(d)&&(v)>-(d))?0:(32768*((v)>0?(v)-(d):(v)+(d))/(32768-(d))))
extern int xpadneo_mouse_event(struct xpadneo_devdata *xdata, struct hid_usage *usage, __s32 value)
{
if (!xdata->mouse_mode)
return 0;

if (usage->type == EV_ABS) {
switch (usage->code) {
case ABS_X:
xdata->mouse_state.rel_x = rescale_axis(value - 32768, 3072) / 2048;
return 1;
case ABS_Y:
xdata->mouse_state.rel_y = rescale_axis(value - 32768, 3072) / 2048;
return 1;
case ABS_RX:
xdata->mouse_state.wheel_x = rescale_axis(value - 32768, 3072) / 8192;
return 1;
case ABS_RY:
xdata->mouse_state.wheel_y = rescale_axis(value - 32768, 3072) / 8192;
return 1;
case ABS_Z:
if (xdata->mouse_state.analog_button.left && value < 384) {
xdata->mouse_state.analog_button.left = false;
input_report_key(xdata->mouse, BTN_LEFT, 0);
input_sync(xdata->mouse);
} else if (!xdata->mouse_state.analog_button.left && value > 640) {
xdata->mouse_state.analog_button.left = true;
input_report_key(xdata->mouse, BTN_LEFT, 1);
input_sync(xdata->mouse);
}
return 1;
case ABS_RZ:
if (xdata->mouse_state.analog_button.right && value < 384) {
xdata->mouse_state.analog_button.right = false;
input_report_key(xdata->mouse, BTN_RIGHT, 0);
input_sync(xdata->mouse);
} else if (!xdata->mouse_state.analog_button.right && value > 640) {
xdata->mouse_state.analog_button.right = true;
input_report_key(xdata->mouse, BTN_RIGHT, 1);
input_sync(xdata->mouse);
}
return 1;
}
} else if (usage->type == EV_KEY) {
switch (usage->code) {
case BTN_TL:
input_report_key(xdata->mouse, BTN_SIDE, value);
input_sync(xdata->mouse);
return 1;
case BTN_TR:
input_report_key(xdata->mouse, BTN_EXTRA, value);
input_sync(xdata->mouse);
return 1;
case BTN_START:
if (xdata->consumer) {
input_report_key(xdata->consumer, KEY_KEYBOARD, value);
input_sync(xdata->consumer);
}
return 1;
}
}

return 0;
}

extern int xpadneo_init_mouse(struct xpadneo_devdata *xdata)
{
struct hid_device *hdev = xdata->hdev;
int ret, synth = 0;

if (!xdata->mouse) {
synth = 1;
ret = xpadneo_init_synthetic(xdata, "Mouse", &xdata->mouse);
if (ret || !xdata->mouse)
return ret;
}

/* enable relative events for mouse emulation */
__set_bit(EV_REL, xdata->mouse->evbit);
__set_bit(REL_X, xdata->mouse->relbit);
__set_bit(REL_Y, xdata->mouse->relbit);
__set_bit(REL_HWHEEL, xdata->mouse->relbit);
__set_bit(REL_WHEEL, xdata->mouse->relbit);

/* enable button events for mouse emulation */
__set_bit(EV_KEY, xdata->mouse->evbit);
__set_bit(BTN_LEFT, xdata->mouse->keybit);
__set_bit(BTN_RIGHT, xdata->mouse->keybit);
__set_bit(BTN_MIDDLE, xdata->mouse->keybit);
__set_bit(BTN_SIDE, xdata->mouse->keybit);
__set_bit(BTN_EXTRA, xdata->mouse->keybit);
__set_bit(BTN_FORWARD, xdata->mouse->keybit);
__set_bit(BTN_BACK, xdata->mouse->keybit);
__set_bit(BTN_TASK, xdata->mouse->keybit);

if (synth) {
ret = input_register_device(xdata->mouse);
if (ret) {
hid_err(hdev, "failed to register mouse\n");
return ret;
}

hid_info(hdev, "mouse added\n");
}

return 0;
}

0 comments on commit 7558671

Please sign in to comment.