Input: synaptics-rmi4 - add support for F03
authorLyude Paul <thatslyude@gmail.com>
Sat, 3 Dec 2016 00:59:07 +0000 (16:59 -0800)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Sat, 3 Dec 2016 01:51:29 +0000 (17:51 -0800)
This adds basic functionality for PS/2 passthrough on Synaptics
Touchpads using RMI4 through smbus.

Reviewed-by: Andrew Duggan <aduggan@synaptics.com>
Signed-off-by: Lyude Paul <thatslyude@gmail.com>
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
drivers/input/rmi4/Kconfig
drivers/input/rmi4/Makefile
drivers/input/rmi4/rmi_bus.c
drivers/input/rmi4/rmi_driver.h
drivers/input/rmi4/rmi_f03.c [new file with mode: 0644]

index a9c36a5fe7083e23e6c8344f8fb298207e6f651a..30cc627a4f4531ff93014ea94bf9835b0b37e8bc 100644 (file)
@@ -39,6 +39,15 @@ config RMI4_SMB
          To compile this driver as a module, choose M here: the module will be
          called rmi_smbus.
 
+config RMI4_F03
+        bool "RMI4 Function 03 (PS2 Guest)"
+        depends on RMI4_CORE && SERIO
+        help
+          Say Y here if you want to add support for RMI4 function 03.
+
+          Function 03 provides PS2 guest support for RMI4 devices. This
+          includes support for TrackPoints on TouchPads.
+
 config RMI4_2D_SENSOR
        bool
        depends on RMI4_CORE
index e7f4ca6c05084a59486e6413f78accfe4abd06d3..a199cbe9c27d9b85cb71286b8e2940e5cb6b53bd 100644 (file)
@@ -4,6 +4,7 @@ rmi_core-y := rmi_bus.o rmi_driver.o rmi_f01.o
 rmi_core-$(CONFIG_RMI4_2D_SENSOR) += rmi_2d_sensor.o
 
 # Function drivers
+rmi_core-$(CONFIG_RMI4_F03) += rmi_f03.o
 rmi_core-$(CONFIG_RMI4_F11) += rmi_f11.o
 rmi_core-$(CONFIG_RMI4_F12) += rmi_f12.o
 rmi_core-$(CONFIG_RMI4_F30) += rmi_f30.o
index 2534331ad9dc59a19e3721e0f720337ba55e451d..df97d8679badbf29b7dcdfa78b657ff9021193ea 100644 (file)
@@ -306,6 +306,9 @@ struct bus_type rmi_bus_type = {
 
 static struct rmi_function_handler *fn_handlers[] = {
        &rmi_f01_handler,
+#ifdef CONFIG_RMI4_F03
+       &rmi_f03_handler,
+#endif
 #ifdef CONFIG_RMI4_F11
        &rmi_f11_handler,
 #endif
index cc94585222791537ac8bd7f364170b78241bcc31..24f8f764d171cafb18fbc878b707006ecdfcc658 100644 (file)
@@ -121,6 +121,7 @@ static inline void rmi_f34_remove_sysfs(struct rmi_device *rmi_dev)
 #endif /* CONFIG_RMI_F34 */
 
 extern struct rmi_function_handler rmi_f01_handler;
+extern struct rmi_function_handler rmi_f03_handler;
 extern struct rmi_function_handler rmi_f11_handler;
 extern struct rmi_function_handler rmi_f12_handler;
 extern struct rmi_function_handler rmi_f30_handler;
diff --git a/drivers/input/rmi4/rmi_f03.c b/drivers/input/rmi4/rmi_f03.c
new file mode 100644 (file)
index 0000000..24c7375
--- /dev/null
@@ -0,0 +1,232 @@
+/*
+ * Copyright (C) 2015-2016 Red Hat
+ * Copyright (C) 2015 Lyude Paul <thatslyude@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 as published by
+ * the Free Software Foundation.
+ */
+
+#include <linux/kernel.h>
+#include <linux/slab.h>
+#include <linux/serio.h>
+#include <linux/notifier.h>
+#include "rmi_driver.h"
+
+#define RMI_F03_RX_DATA_OFB            0x01
+#define RMI_F03_OB_SIZE                        2
+
+#define RMI_F03_OB_OFFSET              2
+#define RMI_F03_OB_DATA_OFFSET         1
+#define RMI_F03_OB_FLAG_TIMEOUT                BIT(6)
+#define RMI_F03_OB_FLAG_PARITY         BIT(7)
+
+#define RMI_F03_DEVICE_COUNT           0x07
+#define RMI_F03_BYTES_PER_DEVICE       0x07
+#define RMI_F03_BYTES_PER_DEVICE_SHIFT 4
+#define RMI_F03_QUEUE_LENGTH           0x0F
+
+struct f03_data {
+       struct rmi_function *fn;
+
+       struct serio *serio;
+
+       u8 device_count;
+       u8 rx_queue_length;
+};
+
+static int rmi_f03_pt_write(struct serio *id, unsigned char val)
+{
+       struct f03_data *f03 = id->port_data;
+       int error;
+
+       rmi_dbg(RMI_DEBUG_FN, &f03->fn->dev,
+               "%s: Wrote %.2hhx to PS/2 passthrough address",
+               __func__, val);
+
+       error = rmi_write(f03->fn->rmi_dev, f03->fn->fd.data_base_addr, val);
+       if (error) {
+               dev_err(&f03->fn->dev,
+                       "%s: Failed to write to F03 TX register (%d).\n",
+                       __func__, error);
+               return error;
+       }
+
+       return 0;
+}
+
+static int rmi_f03_initialize(struct f03_data *f03)
+{
+       struct rmi_function *fn = f03->fn;
+       struct device *dev = &fn->dev;
+       int error;
+       u8 bytes_per_device;
+       u8 query1;
+       u8 query2[RMI_F03_DEVICE_COUNT * RMI_F03_BYTES_PER_DEVICE];
+       size_t query2_len;
+
+       error = rmi_read(fn->rmi_dev, fn->fd.query_base_addr, &query1);
+       if (error) {
+               dev_err(dev, "Failed to read query register (%d).\n", error);
+               return error;
+       }
+
+       f03->device_count = query1 & RMI_F03_DEVICE_COUNT;
+       bytes_per_device = (query1 >> RMI_F03_BYTES_PER_DEVICE_SHIFT) &
+                               RMI_F03_BYTES_PER_DEVICE;
+
+       query2_len = f03->device_count * bytes_per_device;
+
+       /*
+        * The first generation of image sensors don't have a second part to
+        * their f03 query, as such we have to set some of these values manually
+        */
+       if (query2_len < 1) {
+               f03->device_count = 1;
+               f03->rx_queue_length = 7;
+       } else {
+               error = rmi_read_block(fn->rmi_dev, fn->fd.query_base_addr + 1,
+                                      query2, query2_len);
+               if (error) {
+                       dev_err(dev,
+                               "Failed to read second set of query registers (%d).\n",
+                               error);
+                       return error;
+               }
+
+               f03->rx_queue_length = query2[0] & RMI_F03_QUEUE_LENGTH;
+       }
+
+       return 0;
+}
+
+static int rmi_f03_register_pt(struct f03_data *f03)
+{
+       struct serio *serio;
+
+       serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
+       if (!serio)
+               return -ENOMEM;
+
+       serio->id.type = SERIO_8042;
+       serio->write = rmi_f03_pt_write;
+       serio->port_data = f03;
+
+       strlcpy(serio->name, "Synaptics RMI4 PS/2 pass-through",
+               sizeof(serio->name));
+       strlcpy(serio->phys, "synaptics-rmi4-pt/serio1",
+               sizeof(serio->phys));
+       serio->dev.parent = &f03->fn->dev;
+
+       f03->serio = serio;
+
+       serio_register_port(serio);
+
+       return 0;
+}
+
+static int rmi_f03_probe(struct rmi_function *fn)
+{
+       struct device *dev = &fn->dev;
+       struct f03_data *f03;
+       int error;
+
+       f03 = devm_kzalloc(dev, sizeof(struct f03_data), GFP_KERNEL);
+       if (!f03)
+               return -ENOMEM;
+
+       f03->fn = fn;
+
+       error = rmi_f03_initialize(f03);
+       if (error < 0)
+               return error;
+
+       if (f03->device_count != 1)
+               dev_warn(dev, "found %d devices on PS/2 passthrough",
+                        f03->device_count);
+
+       dev_set_drvdata(dev, f03);
+
+       error = rmi_f03_register_pt(f03);
+       if (error)
+               return error;
+
+       return 0;
+}
+
+static int rmi_f03_config(struct rmi_function *fn)
+{
+       fn->rmi_dev->driver->set_irq_bits(fn->rmi_dev, fn->irq_mask);
+
+       return 0;
+}
+
+static int rmi_f03_attention(struct rmi_function *fn, unsigned long *irq_bits)
+{
+       struct f03_data *f03 = dev_get_drvdata(&fn->dev);
+       u16 data_addr = fn->fd.data_base_addr;
+       const u8 ob_len = f03->rx_queue_length * RMI_F03_OB_SIZE;
+       u8 obs[RMI_F03_QUEUE_LENGTH * RMI_F03_OB_SIZE];
+       u8 ob_status;
+       u8 ob_data;
+       unsigned int serio_flags;
+       int i;
+       int error;
+
+       /* Grab all of the data registers, and check them for data */
+       error = rmi_read_block(fn->rmi_dev, data_addr + RMI_F03_OB_OFFSET,
+                               &obs, ob_len);
+       if (error) {
+               dev_err(&fn->dev,
+                       "%s: Failed to read F03 output buffers: %d\n",
+                       __func__, error);
+               serio_interrupt(f03->serio, 0, SERIO_TIMEOUT);
+               return error;
+       }
+
+       for (i = 0; i < ob_len; i += RMI_F03_OB_SIZE) {
+               ob_status = obs[i];
+               ob_data = obs[i + RMI_F03_OB_DATA_OFFSET];
+               serio_flags = 0;
+
+               if (!(ob_status & RMI_F03_RX_DATA_OFB))
+                       continue;
+
+               if (ob_status & RMI_F03_OB_FLAG_TIMEOUT)
+                       serio_flags |= SERIO_TIMEOUT;
+               if (ob_status & RMI_F03_OB_FLAG_PARITY)
+                       serio_flags |= SERIO_PARITY;
+
+               rmi_dbg(RMI_DEBUG_FN, &fn->dev,
+                       "%s: Received %.2hhx from PS2 guest T: %c P: %c\n",
+                       __func__, ob_data,
+                       serio_flags & SERIO_TIMEOUT ?  'Y' : 'N',
+                       serio_flags & SERIO_PARITY ? 'Y' : 'N');
+
+               serio_interrupt(f03->serio, ob_data, serio_flags);
+       }
+
+       return 0;
+}
+
+static void rmi_f03_remove(struct rmi_function *fn)
+{
+       struct f03_data *f03 = dev_get_drvdata(&fn->dev);
+
+       serio_unregister_port(f03->serio);
+}
+
+struct rmi_function_handler rmi_f03_handler = {
+       .driver = {
+               .name = "rmi4_f03",
+       },
+       .func = 0x03,
+       .probe = rmi_f03_probe,
+       .config = rmi_f03_config,
+       .attention = rmi_f03_attention,
+       .remove = rmi_f03_remove,
+};
+
+MODULE_AUTHOR("Lyude Paul <thatslyude@gmail.com>");
+MODULE_DESCRIPTION("RMI F03 module");
+MODULE_LICENSE("GPL");