PlayStation 1/2 joypads can be connected directly to the SPI interface.

Signed-off-by: Tomohiro Yoshidomi <sylph...@gmail.com>
---
 drivers/input/joystick/Kconfig      |  22 ++
 drivers/input/joystick/Makefile     |   1 +
 drivers/input/joystick/psxpad-spi.c | 438 ++++++++++++++++++++++++++++++++++++
 3 files changed, 461 insertions(+)
 create mode 100644 drivers/input/joystick/psxpad-spi.c

diff --git a/drivers/input/joystick/Kconfig b/drivers/input/joystick/Kconfig
index 4215b538..cbcb9a6e 100644
--- a/drivers/input/joystick/Kconfig
+++ b/drivers/input/joystick/Kconfig
@@ -330,4 +330,26 @@ config JOYSTICK_MAPLE
          To compile this as a module choose M here: the module will be called
          maplecontrol.
 
+config JOYSTICK_PSXPAD_SPI
+       tristate "PlayStation 1/2 joypads via SPI interface"
+       depends on SPI
+       select INPUT_POLLDEV
+       help
+         Say Y here if you wish to connect PlayStation 1/2 joypads
+         via SPI interface.
+
+         To compile this driver as a module, choose M here: the
+         module will be called psxpad-spi.
+
+config JOYSTICK_PSXPAD_SPI_FF
+       bool "PlayStation 1/2 joypads force feedback (rumble) support"
+       depends on JOYSTICK_PSXPAD_SPI
+       select INPUT_FF_MEMLESS
+       help
+         Say Y here if you want to take advantage of
+         PlayStation 1/2 joypads rumble features.
+
+         To drive rumble motor,
+         a dedicated power supply is required.
+
 endif
diff --git a/drivers/input/joystick/Makefile b/drivers/input/joystick/Makefile
index 92dc0de9..496fd56b 100644
--- a/drivers/input/joystick/Makefile
+++ b/drivers/input/joystick/Makefile
@@ -21,6 +21,7 @@ obj-$(CONFIG_JOYSTICK_INTERACT)               += interact.o
 obj-$(CONFIG_JOYSTICK_JOYDUMP)         += joydump.o
 obj-$(CONFIG_JOYSTICK_MAGELLAN)                += magellan.o
 obj-$(CONFIG_JOYSTICK_MAPLE)           += maplecontrol.o
+obj-$(CONFIG_JOYSTICK_PSXPAD_SPI)      += psxpad-spi.o
 obj-$(CONFIG_JOYSTICK_SIDEWINDER)      += sidewinder.o
 obj-$(CONFIG_JOYSTICK_SPACEBALL)       += spaceball.o
 obj-$(CONFIG_JOYSTICK_SPACEORB)                += spaceorb.o
diff --git a/drivers/input/joystick/psxpad-spi.c 
b/drivers/input/joystick/psxpad-spi.c
new file mode 100644
index 00000000..2627aecb
--- /dev/null
+++ b/drivers/input/joystick/psxpad-spi.c
@@ -0,0 +1,438 @@
+/*
+ * PlayStation 1/2 joypads via SPI interface Driver
+ *
+ * Copyright (C) 2017 Tomohiro Yoshidomi <sylph...@gmail.com>
+ * Licensed under the GPL-2 or later.
+ *
+ * PlayStation 1/2 joypad's plug (not socket)
+ *  123 456 789
+ * (...|...|...)
+ *
+ * 1: DAT -> MISO (pullup with 1k owm to 3.3V)
+ * 2: CMD -> MOSI
+ * 3: 9V (for motor, if not use N.C.)
+ * 4: GND
+ * 5: 3.3V
+ * 6: Attention -> CS(SS)
+ * 7: SCK -> SCK
+ * 8: N.C.
+ * 9: ACK -> N.C.
+ */
+
+#include <linux/kernel.h>
+#include <linux/device.h>
+#include <linux/input.h>
+#include <linux/input-polldev.h>
+#include <linux/module.h>
+#include <linux/spi/spi.h>
+#include <linux/types.h>
+#include <linux/pm.h>
+#include <linux/pm_runtime.h>
+
+#define REVERSE_BIT(x) ((((x) & 0x80) >> 7) | (((x) & 0x40) >> 5) | \
+       (((x) & 0x20) >> 3) | (((x) & 0x10) >> 1) | (((x) & 0x08) << 1) | \
+       (((x) & 0x04) << 3) | (((x) & 0x02) << 5) | (((x) & 0x01) << 7))
+
+/* PlayStation 1/2 joypad command and response are LSBFIRST. */
+
+/*     0x01, 0x42, 0x00, 0x00, 0x00,
+ *     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ *     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+ */
+static const u8 PSX_CMD_POLL[] = {
+       0x80, 0x42, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+};
+/*     0x01, 0x43, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 */
+static const u8 PSX_CMD_ENTER_CFG[] = {
+       0x80, 0xC2, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00
+};
+/*     0x01, 0x43, 0x00, 0x00, 0x5A, 0x5A, 0x5A, 0x5A, 0x5A */
+static const u8 PSX_CMD_EXIT_CFG[] = {
+       0x80, 0xC2, 0x00, 0x00, 0x5A, 0x5A, 0x5A, 0x5A, 0x5A
+};
+/*     0x01, 0x4D, 0x00, 0x00, 0x01, 0xFF, 0xFF, 0xFF, 0xFF */
+static const u8 PSX_CMD_ENABLE_MOTOR[] = {
+       0x80, 0xB2, 0x00, 0x00, 0x80, 0xFF, 0xFF, 0xFF, 0xFF
+};
+
+struct psxpad {
+       struct spi_device *spi;
+       struct input_polled_dev *pdev;
+       struct input_dev *idev;
+       char phys[0x20];
+       bool motor1enable;
+       bool motor2enable;
+       u8 motor1level;
+       u8 motor2level;
+       u8 sendbuf[0x20] ____cacheline_aligned;
+       u8 response[sizeof(PSX_CMD_POLL)] ____cacheline_aligned;
+};
+
+static int psxpad_command(struct psxpad *pad, const u8 sendcmdlen)
+{
+       struct spi_transfer xfers = {
+               .tx_buf         = pad->sendbuf,
+               .rx_buf         = pad->response,
+               .len            = sendcmdlen,
+       };
+       int err;
+
+       err = spi_sync_transfer(pad->spi, &xfers, 1);
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to SPI xfers mode: %d\n",
+                       __func__, err);
+               return err;
+       }
+
+       return 0;
+}
+
+#ifdef CONFIG_JOYSTICK_PSXPAD_SPI_FF
+static void psxpad_setenablemotor(
+       struct psxpad *pad, bool motor1enable, bool motor2enable)
+{
+       int err;
+
+       pad->motor1enable = motor1enable;
+       pad->motor2enable = motor2enable;
+
+       memcpy(pad->sendbuf, PSX_CMD_ENTER_CFG, sizeof(PSX_CMD_ENTER_CFG));
+       err = psxpad_command(pad, sizeof(PSX_CMD_ENTER_CFG));
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to enter config mode: %d\n",
+                       __func__, err);
+               return;
+       }
+       memcpy(pad->sendbuf,
+               PSX_CMD_ENABLE_MOTOR, sizeof(PSX_CMD_ENABLE_MOTOR));
+       pad->sendbuf[3] = pad->motor1enable ? 0x00 : 0xFF;
+       pad->sendbuf[4] = pad->motor2enable ? 0x80 : 0xFF;
+       err = psxpad_command(pad, sizeof(PSX_CMD_ENABLE_MOTOR));
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to enable motor mode: %d\n",
+                       __func__, err);
+               return;
+       }
+       memcpy(pad->sendbuf, PSX_CMD_EXIT_CFG, sizeof(PSX_CMD_EXIT_CFG));
+       err = psxpad_command(pad, sizeof(PSX_CMD_EXIT_CFG));
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to exit config mode: %d\n",
+                       __func__, err);
+               return;
+       }
+}
+
+static void psxpad_set_motor_level(
+       struct psxpad *pad, u8 motor1level, u8 motor2level)
+{
+       pad->motor1level = motor1level ? 0xFF : 0x00;
+       pad->motor2level = REVERSE_BIT(motor2level);
+}
+#else  /* CONFIG_JOYSTICK_PSXPAD_SPI_FF */
+static void psxpad_setenablemotor(
+       struct psxpad *pad, bool motor1enable, bool motor2enable) { }
+
+static void psxpad_set_motor_level(
+       struct psxpad *pad, u8 motor1level, u8 motor2level) { }
+#endif /* CONFIG_JOYSTICK_PSXPAD_SPI_FF */
+
+static void psxpad_spi_poll_open(struct input_polled_dev *pdev)
+{
+       struct psxpad *pad = pdev->private;
+
+       pm_runtime_get_sync(&pad->spi->dev);
+}
+
+static void psxpad_spi_poll_close(struct input_polled_dev *pdev)
+{
+       struct psxpad *pad = pdev->private;
+
+       pm_runtime_put_sync(&pad->spi->dev);
+}
+
+static void psxpad_spi_poll(struct input_polled_dev *pdev)
+{
+       struct psxpad *pad = pdev->private;
+       int err;
+
+       psxpad_setenablemotor(pad, true, true);
+
+       memcpy(pad->sendbuf, PSX_CMD_POLL, sizeof(PSX_CMD_POLL));
+       pad->sendbuf[3] = pad->motor1enable ? pad->motor1level : 0x00;
+       pad->sendbuf[4] = pad->motor2enable ? pad->motor2level : 0x00;
+       err = psxpad_command(pad, sizeof(PSX_CMD_POLL));
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to poll cmd mode: %d\n",
+                       __func__, err);
+               return;
+       }
+
+       switch (pad->response[1]) {
+       case 0xCE:      /* 0x73 : analog 1 */
+               input_report_abs(pad->idev,
+                       ABS_X,          REVERSE_BIT(pad->response[7]));
+               input_report_abs(pad->idev,
+                       ABS_Y,          REVERSE_BIT(pad->response[8]));
+               input_report_abs(pad->idev,
+                       ABS_RX,         REVERSE_BIT(pad->response[5]));
+               input_report_abs(pad->idev,
+                       ABS_RY,         REVERSE_BIT(pad->response[6]));
+               input_report_key(pad->idev,
+                       BTN_DPAD_UP,    !(pad->response[3] & BIT(3)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_DOWN,  !(pad->response[3] & BIT(1)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_LEFT,  !(pad->response[3] & BIT(0)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_RIGHT, !(pad->response[3] & BIT(2)));
+               input_report_key(pad->idev,
+                       BTN_X,          !(pad->response[4] & BIT(3)));
+               input_report_key(pad->idev,
+                       BTN_A,          !(pad->response[4] & BIT(2)));
+               input_report_key(pad->idev,
+                       BTN_B,          !(pad->response[4] & BIT(1)));
+               input_report_key(pad->idev,
+                       BTN_Y,          !(pad->response[4] & BIT(0)));
+               input_report_key(pad->idev,
+                       BTN_TL,         !(pad->response[4] & BIT(5)));
+               input_report_key(pad->idev,
+                       BTN_TR,         !(pad->response[4] & BIT(4)));
+               input_report_key(pad->idev,
+                       BTN_TL2,        !(pad->response[4] & BIT(7)));
+               input_report_key(pad->idev,
+                       BTN_TR2,        !(pad->response[4] & BIT(6)));
+               input_report_key(pad->idev,
+                       BTN_THUMBL,     !(pad->response[3] & BIT(6)));
+               input_report_key(pad->idev,
+                       BTN_THUMBR,     !(pad->response[3] & BIT(5)));
+               input_report_key(pad->idev,
+                       BTN_SELECT,     !(pad->response[3] & BIT(7)));
+               input_report_key(pad->idev,
+                       BTN_START,      !(pad->response[3] & BIT(4)));
+               break;
+
+       case 0x82:      /* 0x41 : digital */
+               input_report_abs(pad->idev,
+                       ABS_X,          0x80);
+               input_report_abs(pad->idev,
+                       ABS_Y,          0x80);
+               input_report_abs(pad->idev,
+                       ABS_RX,         0x80);
+               input_report_abs(pad->idev,
+                       ABS_RY,         0x80);
+               input_report_key(pad->idev,
+                       BTN_DPAD_UP,    !(pad->response[3] & BIT(3)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_DOWN,  !(pad->response[3] & BIT(1)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_LEFT,  !(pad->response[3] & BIT(0)));
+               input_report_key(pad->idev,
+                       BTN_DPAD_RIGHT, !(pad->response[3] & BIT(2)));
+               input_report_key(pad->idev,
+                       BTN_X,          !(pad->response[4] & BIT(3)));
+               input_report_key(pad->idev,
+                       BTN_A,          !(pad->response[4] & BIT(2)));
+               input_report_key(pad->idev,
+                       BTN_B,          !(pad->response[4] & BIT(1)));
+               input_report_key(pad->idev,
+                       BTN_Y,          !(pad->response[4] & BIT(0)));
+               input_report_key(pad->idev,
+                       BTN_TL,         !(pad->response[4] & BIT(5)));
+               input_report_key(pad->idev,
+                       BTN_TR,         !(pad->response[4] & BIT(4)));
+               input_report_key(pad->idev,
+                       BTN_TL2,        !(pad->response[4] & BIT(7)));
+               input_report_key(pad->idev,
+                       BTN_TR2,        !(pad->response[4] & BIT(6)));
+               input_report_key(pad->idev,
+                       BTN_THUMBL,     false);
+               input_report_key(pad->idev,
+                       BTN_THUMBR,     false);
+               input_report_key(pad->idev,
+                       BTN_SELECT,     !(pad->response[3] & BIT(7)));
+               input_report_key(pad->idev,
+                       BTN_START,      !(pad->response[3] & BIT(4)));
+               break;
+       }
+
+       input_sync(pad->idev);
+}
+
+#ifdef CONFIG_JOYSTICK_PSXPAD_SPI_FF
+static int psxpad_spi_ff(
+       struct input_dev *idev, void *data, struct ff_effect *effect)
+{
+       struct input_polled_dev *pdev = input_get_drvdata(idev);
+       struct psxpad *pad = pdev->private;
+
+       switch (effect->type) {
+       case FF_RUMBLE:
+               psxpad_set_motor_level(pad,
+                       (effect->u.rumble.weak_magnitude >> 8) & 0xFFU,
+                       (effect->u.rumble.strong_magnitude >> 8) & 0xFFU);
+               break;
+       }
+
+       return 0;
+}
+
+static int psxpad_spi_init_ff(struct psxpad *pad)
+{
+       int err;
+
+       input_set_capability(pad->idev, EV_FF, FF_RUMBLE);
+       err = input_ff_create_memless(pad->idev, NULL, psxpad_spi_ff);
+       if (err) {
+               dev_err(&pad->spi->dev,
+                       "%s: failed to ff alloc mode: %d\n",
+                       __func__, err);
+       }
+
+       return err;
+}
+#else  /* CONFIG_JOYSTICK_PSXPAD_SPI_FF */
+static inline int psxpad_spi_init_ff(struct psxpad *pad)
+{
+       return 0;
+}
+#endif /* CONFIG_JOYSTICK_PSXPAD_SPI_FF */
+
+static int psxpad_spi_probe(struct spi_device *spi)
+{
+       struct psxpad *pad;
+       struct input_polled_dev *pdev;
+       struct input_dev *idev;
+       int err;
+
+       pad = devm_kzalloc(&spi->dev, sizeof(struct psxpad), GFP_KERNEL);
+       if (!pad)
+               return -ENOMEM;
+       pdev = input_allocate_polled_device();
+       if (!pdev) {
+               dev_err(&spi->dev,
+                       "%s: failed to pdev alloc\n",
+                       __func__);
+               return -ENOMEM;
+       }
+
+       /* input poll device settings */
+       pad->pdev = pdev;
+       pad->spi = spi;
+       pad->motor1enable = false;
+       pad->motor2enable = false;
+       pdev->private = pad;
+       pdev->open = psxpad_spi_poll_open;
+       pdev->close = psxpad_spi_poll_close;
+       pdev->poll = psxpad_spi_poll;
+       /* poll interval is about 60fps */
+       pdev->poll_interval = 16;
+       pdev->poll_interval_min = 8;
+       pdev->poll_interval_max = 32;
+
+       /* input device settings */
+       idev = pdev->input;
+       pad->idev = idev;
+       idev->name = "PlayStation 1/2 joypad";
+       snprintf(pad->phys, sizeof(pad->phys), "%s/input", dev_name(&spi->dev));
+       idev->id.bustype = BUS_SPI;
+
+       /* key/value map settings */
+       input_set_abs_params(idev, ABS_X,       0, 255, 0, 0);
+       input_set_abs_params(idev, ABS_Y,       0, 255, 0, 0);
+       input_set_abs_params(idev, ABS_RX,      0, 255, 0, 0);
+       input_set_abs_params(idev, ABS_RY,      0, 255, 0, 0);
+       input_set_capability(idev, EV_KEY,      BTN_DPAD_UP);
+       input_set_capability(idev, EV_KEY,      BTN_DPAD_DOWN);
+       input_set_capability(idev, EV_KEY,      BTN_DPAD_LEFT);
+       input_set_capability(idev, EV_KEY,      BTN_DPAD_RIGHT);
+       input_set_capability(idev, EV_KEY,      BTN_A);
+       input_set_capability(idev, EV_KEY,      BTN_B);
+       input_set_capability(idev, EV_KEY,      BTN_X);
+       input_set_capability(idev, EV_KEY,      BTN_Y);
+       input_set_capability(idev, EV_KEY,      BTN_TL);
+       input_set_capability(idev, EV_KEY,      BTN_TR);
+       input_set_capability(idev, EV_KEY,      BTN_TL2);
+       input_set_capability(idev, EV_KEY,      BTN_TR2);
+       input_set_capability(idev, EV_KEY,      BTN_THUMBL);
+       input_set_capability(idev, EV_KEY,      BTN_THUMBR);
+       input_set_capability(idev, EV_KEY,      BTN_SELECT);
+       input_set_capability(idev, EV_KEY,      BTN_START);
+
+       /* force feedback */
+       err = psxpad_spi_init_ff(pad);
+       if (err) {
+               dev_err(&spi->dev,
+                       "%s: failed to init ff mode: %d\n",
+                       __func__, err);
+               return err;
+       }
+
+       /* SPI settings */
+       spi->mode = SPI_MODE_3;
+       spi->bits_per_word = 8;
+       /* (PlayStation 1/2 joypad might be possible works 250kHz/500kHz) */
+       spi->master->min_speed_hz = 125000;
+       spi->master->max_speed_hz = 125000;
+       spi_setup(spi);
+
+       /* pad settings */
+       psxpad_set_motor_level(pad, 0, 0);
+
+       /* register input poll device */
+       err = input_register_polled_device(pdev);
+       if (err) {
+               dev_err(&spi->dev,
+                       "%s: failed to register input poll device: %d\n",
+                       __func__, err);
+               return err;
+       }
+
+       pm_runtime_enable(&spi->dev);
+
+       return 0;
+}
+
+static int __maybe_unused psxpad_spi_suspend(struct device *dev)
+{
+       struct spi_device *spi = to_spi_device(dev);
+       struct psxpad *pad = spi_get_drvdata(spi);
+
+       psxpad_set_motor_level(pad, 0, 0);
+
+       return 0;
+}
+
+static int __maybe_unused psxpad_spi_resume(struct device *dev)
+{
+       return 0;
+}
+
+static SIMPLE_DEV_PM_OPS(psxpad_spi_pm, psxpad_spi_suspend, psxpad_spi_resume);
+
+static const struct spi_device_id psxpad_spi_id[] = {
+       { "psxpad-spi", 0 },
+       { }
+};
+MODULE_DEVICE_TABLE(spi, psxpad_spi_id);
+
+static struct spi_driver psxpad_spi_driver = {
+       .driver = {
+               .name = "psxpad-spi",
+               .pm = &psxpad_spi_pm,
+       },
+       .id_table = psxpad_spi_id,
+       .probe   = psxpad_spi_probe,
+};
+
+module_spi_driver(psxpad_spi_driver);
+
+MODULE_AUTHOR("Tomohiro Yoshidomi <sylph...@gmail.com>");
+MODULE_DESCRIPTION("PlayStation 1/2 joypads via SPI interface Driver");
+MODULE_LICENSE("GPL");
-- 
2.11.0

Reply via email to